MarkdownCopies this page as Markdown, ready to paste into an AI assistant.
Gmail API
2 Gmail endpoints behind one key, priced in credits per call and routed to the cheapest healthy source.
On this page
Knowledge & Data · 2 endpoints · from 1 credit per call
Endpoints
- POSTGmail Message
/v1/run/gmail.messageReads one message from the connected Gmail mailbox: headers, plain-text and HTML body, and the attachment list.1 creditper call - POSTGmail Search
/v1/run/gmail.searchSearches the connected Gmail mailbox with Gmail search syntax and returns sender, subject, date and snippet per message.1 creditper call
Calling them
Every endpoint on this page is one POST to https://api.primaryapi.com/v1/run/{sku} with your API key and a JSON body. Responses share one envelope, so code written for one endpoint handles the others. For example, gmail.message:
curl -sS -X POST "https://api.primaryapi.com/v1/run/gmail.message" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"id":"18c3a1f0e2b4d5f6"}'const res = await fetch('https://api.primaryapi.com/v1/run/gmail.message', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
id: '18c3a1f0e2b4d5f6',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/gmail.message",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"id": "18c3a1f0e2b4d5f6",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"])New to PrimaryAPI? Start with the Quickstart, then read Making requests.