Start
Build with your AI
Written beside the API’s code, and read from it every hour.
Two roads for your own AI, each with its limit in the same breath. A coding assistant can read this guide and the reference and write your integration, and the rules below keep its code safe the first time. Your AI agent can place a call from your own software; the recipe is Place an AI agent call. A connector that lets Claude or ChatGPT read your account directly is not built yet, so until it is, the way in for any AI is this API with your key.
The files to hand over
- The whole guide in one file. vocatech.com/developers/guide.md, and each page of the guide on its own at its address with
.mdadded. - Every route in one file. The OpenAPI file at vocatech.com/developers/openapi.yml, the file most coding tools read first, with every field, answer and error.
- A map for AI tools. vocatech.com/llms.txt names the pages an assistant should read first, this guide and the reference among them.
The rules to paste first
Paste these into the assistant before it writes a line. Each one is a rule of this guide.
You are writing code against the Vocatech API.
Read https://vocatech.com/developers/guide.md and https://vocatech.com/developers/openapi.yml first.
- Call the API from a server only. It sends no CORS headers. Keep the key in an environment variable, never in a browser, an app or a repository.
- Send a text or a fax with "test": true first. Without it, a real one goes out.
- On a 429, wait the seconds in Retry-After. Each kind of request has its own counter.
- Check X-Vocatech-Signature on the raw body of every webhook, and answer within five seconds.
- Send an Idempotency-Key with every AI agent call, so a retry never places a second call.
- Dates you ask for are read in New York time unless you send a timezone. Every time comes back in UTC.
- The API reads and sends. It never changes call settings, so do not look for a route that does.Your AI agent, called from your software
Your software names the person, the reason and what to say, and the agent places the call inside its calling hours, works with the jobs it has and reports through its message delivery, marked with your reference. One call per request, at most fifty a day for each agent, never an emergency, premium or foreign number. The whole recipe is Place an AI agent call.
