Building with an AI agent? Point it at these and it can integrate on its own:
- OpenAPI spec:
https://api.useinvent.com/openapi.json - Interactive reference: api.useinvent.com/docs
- Machine-readable index: docs.useinvent.com/llms.txt and llms-full.txt
- Any page as Markdown: add
.mdto its URL (for example introduction.md)
Authorization: Bearer YOUR_API_KEY, then hand the agent the OpenAPI spec and let it go.Explore the full API
The complete API is described by an OpenAPI 3.1 spec. Browse it interactively or hand the raw spec to your client or agent.OpenAPI spec
The full machine-readable spec (
openapi.json). Import it into your client or pass it to an agent.Swagger UI
Navigate and try every endpoint interactively.
Base URL
The Invent API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP. All requests contain the following base URL:Authentication
To authenticate, you need to add an Authorization header with the contents beingBearer YOUR_API_KEY.
Organization-scoped routes
Resources are under/orgs/{org_id}/... (for example GET /orgs/{org_id}/assistants).
{org_id}=c: with Bearer API key auth,cis always the org the key was issued for (e.g. the parent if the key was created on the parent). Example:GET https://api.useinvent.com/orgs/c/assistants.- Explicit
org_id: use the real organization id for any other workspace, including a sub-organization when the key is a parent key.cdoes not refer to a sub-org, so you must pass the sub-org’s id in the path. See sub-organizations in API Keys.
Response codes
Invent uses standard HTTP codes to indicate the success or failure of your requests. In general,2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.
| Status | Description |
|---|---|
200 | Successful request. |
400 | Check that the parameters were correct. |
401 | Check that the API key is correct. |
404 | The resource was not found. |
429 | The rate limit was exceeded. |
5xx | Indicates an error with Invent servers. |
Rate limits
Invent enforces rate limits to ensure fair usage of the API. If you exceed the rate limit, you will receive a429 status code.
The rate limit is set at 500 requests per minute per IP address.