Reference
SDK integration (OpenAI, Anthropic, AI SDK), rate limits, and error codes.
SDK integration (OpenAI, Anthropic, AI SDK), rate limits, and error codes.
Use the official OpenAI Node.js SDK with anymize as the base URL.
1npm install openaiUse the official OpenAI Python SDK with anymize as the base URL.
1pip install openaiDifferent base URLs are used depending on the feature.
https://app.anymize.ai/api/v1/llmhttps://app.anymize.ai/api/v1/llm-anonymoushttps://app.anymize.ai/api/v1/llm/responseshttps://app.anymize.ai/apiThe API accepts JSON (application/json) and multipart/form-data for file uploads.
Compatibility tip
Official @anthropic-ai/sdk. Point the base URL at /api; the client appends /v1/messages. apiKey is sent as x-api-key, which anymize accepts.
1npm install @anthropic-ai/sdkanthropic.Anthropic with base_url on /api. api_key sends x-api-key (works). auth_token sends Bearer, same as Claude Code.
1pip install anthropiccreateOpenAI with baseURL .../api/v1/llm talks Chat Completions. generateText, streamText, tools: same as api.openai.com, plus anonymization.
1import { createOpenAI } from "@ai-sdk/openai" 2import { generateText } from "ai" 34const openai = createOpenAI({5 apiKey: "YOUR_API_KEY" ,6 baseURL: "https://app.anymize.ai/api/v1/llm" ,7})89const { text } = await generateText({10 model: openai.chat("fountain-1 .0 " ),11 prompt: "Hello" ,12})Vercel AI SDK (Anthropic provider)
Each API key has default limits per minute and per day.
| Endpoint | Per minute | Per day |
|---|---|---|
| LLM Chat | 60 | 1,000 |
| Anonymous Chat | 30 | 500 |
| Anonymize | 60 | 2,000 |
| Models | 120 | — |
Every response includes headers with current limits and usage.
X-RateLimit-Limit-RequestsMaximum number of allowed requests.Retry-AfterTime when the limit resets (Unix timestamp).When exceeded, you'll get a 429 error with a Retry-After header.
{
"error": {
"message": "Rate limit exceeded. Please retry after 30 seconds.",
"type": "rate_limit_error",
"code": "rate_limit_exceeded"
}
}Wait for the time specified in the Retry-After header before retrying.
1# Check rate limit headers in the response 2curl -i -X POST https://app.anymize.ai/api/v1/llm/chat/completions \3 -H "Authorization: Bearer YOUR_API_KEY" \4 -H "Content-Type: application/json" \5 -d '{6 "model" : "fountain-1 .0 " ,7 "messages" : [{"role" : "user" , "content" : "Hello!" }]8 }'910# Response headers include: 11# X-RateLimit-Limit-Requests: 60 12# Retry-After: 30 In addition to rate limits, credit-based limits apply depending on your plan.
Need higher limits? Contact us for an enterprise plan.
Tip
All API endpoints use standard HTTP status codes.
| Code | Status | Description |
|---|---|---|
200 | OK | Success — request was processed. |
202 | Accepted | Accepted — job was created and is being processed. |
400 | Bad Request | Bad request — check your parameters. |
401 | Unauthorized | Not authenticated — API key is missing or invalid. |
403 | Forbidden | Access denied — no permission for this resource. |
404 | Not Found | Not found — endpoint or resource does not exist. |
429 | Too Many Requests | Too many requests — rate limit exceeded. |
500 | Internal Server Error | Server error — try again later. |
503 | Service Unavailable | Service unavailable — temporary maintenance. |
Errors are returned as JSON with an error object.
{
"error": {
"message": "Missing required field: messages",
"type": "invalid_request_error",
"code": "missing_messages",
"param": "messages"
}
}Each error has a type that describes its category.
invalid_request_errorInvalid request — parameters are missing or incorrect.auth_errorAuthentication error — check your API key.rate_limit_errorRate limit — too many requests in a short time.api_errorAPI error — internal server-side issue.Specific error codes for common problems.
| Error code | HTTP status | Description |
|---|---|---|
invalid_api_key | 401 | API key is invalid or expired. |
model_not_found | 404 | The specified model does not exist. |
missing_messages | 400 | The messages array is missing from the request. |
missing_model | 400 | The model parameter is missing from the request. |
rate_limit_exceeded | 429 | Rate limit has been exceeded. |
service_unavailable | 503 | The service is temporarily unavailable. |
{
"error": {
"message": "Invalid API key",
"type": "auth_error",
"code": "invalid_api_key"
}
}{
"error": {
"message": "Model 'gpt-nonexistent' not found",
"type": "invalid_request_error",
"code": "model_not_found",
"param": "model"
}
}{
"error": {
"message": "Rate limit exceeded. Please retry after 30 seconds.",
"type": "rate_limit_error",
"code": "rate_limit_exceeded"
}
}{
"error": {
"message": "The model is currently overloaded. Please try again later.",
"type": "api_error",
"code": "service_unavailable"
}
}Recommendations for robust error handling.
Retry warning
114 maintained integration operations within 467 routes and 673 total endpoints.
Stable, curated contracts for external integrations.
114 matches
/api/v1/agents/assetssession or API key/api/v1/agents/connected-research/chat/completionsAPI key only/api/v1/agents/rag/chat/completionsAPI key only/api/v1/agents/workspace/chat/completionsAPI key only/api/anonymizeAPI key only/api/v1/chunks/:idsession or API key/api/deanonymizesession or API key/api/v1/jobssession or API key/api/v1/jobs/:idsession or API key/api/v1/jobs/:id/exportsession or API key/api/v1/jobs/upload-textsession or API key/api/v1/jobs/upload-urlsession or API key/api/v1/knowledge-basessession or API key/api/v1/knowledge-bases/:idsession or API key/api/v1/knowledge-bases/:id/documentssession or API key/api/v1/knowledge-bases/:id/processsession or API key/api/v1/knowledge-bases/:id/uploadsession or API key/api/v1/llm/chat/completionsAPI key only/api/v1/llm/embeddingsAPI key only/api/v1/llm/modelsAPI key only/api/v1/llm/models/:idAPI key only/api/v1/llm/responsesAPI key only/api/v1/llm-anonymous/chat/completionsAPI key only/api/mcpAPI key only/api/mcp/anymizeAPI key only/api/mcp/skillsAPI key only/api/v1/meetingssession or API key/api/v1/meetings/:idsession or API key/api/v1/memory/project/:projectIdsession or API key/api/v1/messagesAPI key only/api/v1/messages/count_tokensAPI key only/api/v1/modelssession or API key/api/ocrAPI key only/api/v1/office/capabilitiessession or API key/api/v1/projectssession or API key/api/v1/projects/:idsession or API key/api/v1/projects/:id/documentssession or API key/api/v1/projects/:id/knowledge-basessession or API key/api/v1/projects/enhance-instructionsession or API key/api/v1/rag/searchsession or API key/api/status/:uuidAPI key only/api/status/:uuid/stringsAPI key only/api/transcribeAPI key only/api/v1/transcriptionssession or API key/api/v1/transcriptions/:idsession or API key/api/v1/workspace/deltasession or API key/api/v1/workspace/fssession or API key/api/v1/workspace/imagessession or API key/api/v1/workspace/images/:namesession or API key/api/v1/workspace/images/from-urlsession or API key/api/v1/workspace/inboxsession or API key/api/v1/workspace/mountssession or API key/api/v1/workspace/mounts/:idsession or API key/api/v1/workspace/mounts/:id/syncsession or API key/api/v1/workspace/nodessession or API key/api/v1/workspace/nodes/:idsession or API key/api/v1/workspace/nodes/:id/activitysession or API key/api/v1/workspace/nodes/:id/agent-locksession or API key/api/v1/workspace/nodes/:id/commentssession or API key/api/v1/workspace/nodes/:id/comments/:threadIdsession or API key/api/v1/workspace/nodes/:id/comments/:threadId/messagessession or API key/api/v1/workspace/nodes/:id/completesession or API key/api/v1/workspace/nodes/:id/contentsession or API key/api/v1/workspace/nodes/:id/copysession or API key/api/v1/workspace/nodes/:id/diffsession or API key/api/v1/workspace/nodes/:id/docx/header-footersession or API key/api/v1/workspace/nodes/:id/docx/page-setupsession or API key/api/v1/workspace/nodes/:id/downloadsession or API key/api/v1/workspace/nodes/:id/office-viewsession or API key/api/v1/workspace/nodes/:id/permanentsession or API key/api/v1/workspace/nodes/:id/previewsession or API key/api/v1/workspace/nodes/:id/proofreadsession or API key/api/v1/workspace/nodes/:id/restoresession or API key/api/v1/workspace/nodes/:id/sharessession or API key/api/v1/workspace/nodes/:id/sheetsession or API key/api/v1/workspace/nodes/:id/sheet/analysissession or API key/api/v1/workspace/nodes/:id/sheet/searchsession or API key/api/v1/workspace/nodes/:id/starsession or API key/api/v1/workspace/nodes/:id/thumbnailsession or API key/api/v1/workspace/nodes/by-pathsession or API key/api/v1/workspace/overviewsession or API key/api/v1/workspace/restore-requests/:idsession or API key/api/v1/workspace/searchsession or API key/api/v1/workspace/uploadsession or API key/api/v1/workspace/uploadssession or API key/api/v1/workspace/uploads/:sessionIdsession or API key/api/v1/workspace/usagesession or API key/api/v1/workspace/versionssession or API key