addDomain
ChatGPTClaim a new domain and receive the DNS records to publish. Returns dns_records with the exact records to add. If the domain has an mx_conflict (existing mail provider), re-call with confirmed: true to proceed. After publishing DNS records, call verifyDomain to complete setup.
addDomain
ChatGPTClaim a new domain and receive the DNS records to publish. Returns dns_records with the exact records to add. If the domain has an mx_conflict (existing mail provider), re-call with confirmed: true to proceed. After publishing DNS records, call verifyDomain to complete setup.
awaitReply
ChatGPTGet the threaded reply to a sent email — the canonical 'did they reply yet?' call. Pass the sent email's id (from a sendEmail response). With wait=true it long-polls up to wait_timeout_ms for the reply to arrive (synchronous agent-to-agent chat); with wait=false (default) it returns immediately with the reply if one has arrived, else reply=null. Matches on the reply's threading, not a from/subject guess.
awaitReply
ChatGPTGet the threaded reply to a sent email — the canonical 'did they reply yet?' call. Pass the sent email's id (from a sendEmail response). With wait=true it long-polls up to wait_timeout_ms for the reply to arrive (synchronous agent-to-agent chat); with wait=false (default) it returns immediately with the reply if one has arrived, else reply=null. Matches on the reply's threading, not a from/subject guess.
createEndpoint
ChatGPTCreate a webhook endpoint to receive email.received events. If an endpoint with the same URL already exists but is deactivated, it is reactivated. After creating, call testEndpoint to confirm your signature verifier accepts the payload.
createEndpoint
ChatGPTCreate a webhook endpoint to receive email.received events. If an endpoint with the same URL already exists but is deactivated, it is reactivated. After creating, call testEndpoint to confirm your signature verifier accepts the payload.
createFilter
ChatGPTCreate a whitelist or blocklist filter rule. Patterns are stored lowercase. Per-domain filters require a Pro plan.
createFilter
ChatGPTCreate a whitelist or blocklist filter rule. Patterns are stored lowercase. Per-domain filters require a Pro plan.
deleteEndpoint
ChatGPTSoft-delete a webhook endpoint. The endpoint will no longer receive deliveries.
deleteEndpoint
ChatGPTSoft-delete a webhook endpoint. The endpoint will no longer receive deliveries.
deleteFilter
ChatGPTDelete a filter rule.
deleteFilter
ChatGPTDelete a filter rule.
downloadDomainZoneFile
ChatGPTDownload a BIND-format DNS zone file for a domain. Useful when users want to import all required DNS records at once rather than copying them individually. Returns plain text in BIND zone file format.
downloadDomainZoneFile
ChatGPTDownload a BIND-format DNS zone file for a domain. Useful when users want to import all required DNS records at once rather than copying them individually. Returns plain text in BIND zone file format.
downloadEmailAttachments
ChatGPTDownload all attachments for an inbound email as a gzip-compressed tar archive. Returns the archive as a base64-encoded string along with the attachment count and SHA-256 digest. Prefer getEmail first to check the attachment manifest before downloading.
downloadEmailAttachments
ChatGPTDownload all attachments for an inbound email as a gzip-compressed tar archive. Returns the archive as a base64-encoded string along with the attachment count and SHA-256 digest. Prefer getEmail first to check the attachment manifest before downloading.
getAccount
ChatGPTUse this when you need the authenticated Primitive account summary, including email, plan, onboarding state, and webhook secret rotation time.
getAccount
ChatGPTUse this when you need the authenticated Primitive account summary, including email, plan, onboarding state, and webhook secret rotation time.
getConversation
ChatGPTGet the full conversation an inbound email belongs to as ordered, chat-model-ready turns with bodies. Each message is oldest-first with a direction (inbound/outbound) and a derived role (inbound→user, outbound→assistant). For a brand-new message, returns just that one turn. The response includes a truncated boolean (true when the message cap was reached) and a message_count field.
getConversation
ChatGPTGet the full conversation an inbound email belongs to as ordered, chat-model-ready turns with bodies. Each message is oldest-first with a direction (inbound/outbound) and a derived role (inbound→user, outbound→assistant). For a brand-new message, returns just that one turn. The response includes a truncated boolean (true when the message cap was reached) and a message_count field.
getEmail
ChatGPTUse this when you need full details for one inbound email ID, including parsed bodies, threading metadata, SMTP envelope, webhook state, and replies.
getEmail
ChatGPTUse this when you need full details for one inbound email ID, including parsed bodies, threading metadata, SMTP envelope, webhook state, and replies.
getInboxStatus
ChatGPTUse this when the user asks whether inbound email is ready or needs setup. Returns domains, routes, deployed Functions, and recent inbound activity.
getInboxStatus
ChatGPTUse this when the user asks whether inbound email is ready or needs setup. Returns domains, routes, deployed Functions, and recent inbound activity.
getOutboundStatus
ChatGPTWhat can I send FROM? Lists this account's verified outbound (sendable) domains plus any domains still pending DNS verification, with next actions. Call this BEFORE sendEmail to pick a valid from domain — the account email is not necessarily sendable. The same sendable list is echoed in a cannot_send_from_domain error.
getOutboundStatus
ChatGPTWhat can I send FROM? Lists this account's verified outbound (sendable) domains plus any domains still pending DNS verification, with next actions. Call this BEFORE sendEmail to pick a valid from domain — the account email is not necessarily sendable. The same sendable list is echoed in a cannot_send_from_domain error.
getSentEmail
ChatGPTGet the full record for a single sent email by id, including body_text and body_html. Use to inspect delivery details for a specific send — e.g. the SMTP response on a bounced row, or the gate denial reason on a gate_denied row.
getSentEmail
ChatGPTGet the full record for a single sent email by id, including body_text and body_html. Use to inspect delivery details for a specific send — e.g. the SMTP response on a bounced row, or the gate denial reason on a gate_denied row.
getThread
ChatGPTGet a conversation thread by id: metadata plus all inbound and outbound messages interleaved oldest-first. Each message has a direction (inbound/outbound) and id; fetch inbound message bodies via getEmail, or outbound bodies via getSentEmail. Discover thread_id from any email or sent-email record. Compare message_count against messages.length to detect truncation.
getThread
ChatGPTGet a conversation thread by id: metadata plus all inbound and outbound messages interleaved oldest-first. Each message has a direction (inbound/outbound) and id; fetch inbound message bodies via getEmail, or outbound bodies via getSentEmail. Discover thread_id from any email or sent-email record. Compare message_count against messages.length to detect truncation.
listDomains
ChatGPTList all inbound domains for the organization, both verified and unverified. Each domain includes its verification status and DNS records. Use before addDomain to check whether a domain is already claimed.
listDomains
ChatGPTList all inbound domains for the organization, both verified and unverified. Each domain includes its verification status and DNS records. Use before addDomain to check whether a domain is already claimed.
listEmails
ChatGPTUse this when you need to browse inbound emails received at verified domains with cursor pagination, status filters, date filters, or sender/recipient search.
listEmails
ChatGPTUse this when you need to browse inbound emails received at verified domains with cursor pagination, status filters, date filters, or sender/recipient search.
listEndpoints
ChatGPTList all active webhook endpoints for the organization. Each endpoint shows its URL, enabled state, and optional domain restriction.
listEndpoints
ChatGPTList all active webhook endpoints for the organization. Each endpoint shows its URL, enabled state, and optional domain restriction.
listFilters
ChatGPTList all whitelist and blocklist filter rules for the organization.
listFilters
ChatGPTList all whitelist and blocklist filter rules for the organization.
listSentEmails
ChatGPTList outbound emails sent by this org, with cursor pagination and filters. Bodies are omitted from list rows to keep responses small — use getSentEmail to fetch a specific row with full body. Useful for auditing delivery status, finding bounced sends, or checking gate-denied attempts.
listSentEmails
ChatGPTList outbound emails sent by this org, with cursor pagination and filters. Bodies are omitted from list rows to keep responses small — use getSentEmail to fetch a specific row with full body. Useful for auditing delivery status, finding bounced sends, or checking gate-denied attempts.
listWebhookDeliveries
ChatGPTList webhook delivery attempts with pagination and filters. Each delivery includes the target endpoint and a nested email object with sender/recipient/subject. Useful for diagnosing delivery failures or confirming a specific email was delivered.
listWebhookDeliveries
ChatGPTList webhook delivery attempts with pagination and filters. Each delivery includes the target endpoint and a nested email object with sender/recipient/subject. Useful for diagnosing delivery failures or confirming a specific email was delivered.
replayWebhookDelivery
ChatGPTRe-send a stored webhook payload from a previous delivery attempt to its original endpoint. Rate limited per org (burst + sustained windows, shared budget with email webhook replays).
replayWebhookDelivery
ChatGPTRe-send a stored webhook payload from a previous delivery attempt to its original endpoint. Rate limited per org (burst + sustained windows, shared budget with email webhook replays).
replyToEmail
ChatGPTUse this when the user has selected a specific inbound email and confirmed a reply. Sends real outbound email with threading handled server-side.
replyToEmail
ChatGPTUse this when the user has selected a specific inbound email and confirmed a reply. Sends real outbound email with threading handled server-side.
searchEmails
ChatGPTUse this when you need to find inbound emails with structured filters or full-text matching. Use sort=received_at_asc plus date_from for new-mail polling.
searchEmails
ChatGPTUse this when you need to find inbound emails with structured filters or full-text matching. Use sort=received_at_asc plus date_from for new-mail polling.
sendEmail
ChatGPTUse this when the user has confirmed a new outbound email. Sends real email through Primitive's relay and can wait for the first SMTP delivery outcome.
sendEmail
ChatGPTUse this when the user has confirmed a new outbound email. Sends real email through Primitive's relay and can wait for the first SMTP delivery outcome.
sendEmailDemo
ChatGPTSend a SIMULATED email with no account required. Validates the body against the exact same schema as sendEmail, then returns a realistic synthetic success envelope (demo: true) — it never actually sends, queues, or stores anything. Use this to let someone try Primitive and see the response shape before they sign up. To send for real, sign up for an API key and use sendEmail.
sendEmailDemo
ChatGPTSend a SIMULATED email with no account required. Validates the body against the exact same schema as sendEmail, then returns a realistic synthetic success envelope (demo: true) — it never actually sends, queues, or stores anything. Use this to let someone try Primitive and see the response shape before they sign up. To send for real, sign up for an API key and use sendEmail.
testEndpoint
ChatGPTSend a sample email.received event to a webhook endpoint to verify your signature verifier. Rate limited to 4/min and 30/hr. Successful deliveries and verified-domain endpoints are exempt.
testEndpoint
ChatGPTSend a sample email.received event to a webhook endpoint to verify your signature verifier. Rate limited to 4/min and 30/hr. Successful deliveries and verified-domain endpoints are exempt.
verifyDomain
ChatGPTCheck DNS records for a domain claim (MX, TXT, SPF, DKIM, DMARC). On success the domain becomes verified and starts receiving mail. On failure, returns which checks passed and which still need attention. If DNS propagation is incomplete, wait a few minutes and retry.
verifyDomain
ChatGPTCheck DNS records for a domain claim (MX, TXT, SPF, DKIM, DMARC). On success the domain becomes verified and starts receiving mail. On failure, returns which checks passed and which still need attention. If DNS propagation is incomplete, wait a few minutes and retry.
