Agent SwarmAPI Keys
Manage API keys for authenticating requests to the Agent Swarm API
Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
1 <= valueResponse Body
curl -X GET "http://localhost:3013/api/keys/available?keyType=string&totalKeys=1"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/keys/clear-rate-limit" \ -H "Content-Type: application/json" \ -d '{ "keyType": "string", "keySuffix": "string" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
Response Body
curl -X GET "http://localhost:3013/api/keys/costs"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PATCH "http://localhost:3013/api/keys/name" \ -H "Content-Type: application/json" \ -d '{ "keyType": "string", "keySuffix": "string", "name": "string" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/keys/report-rate-limit" \ -H "Content-Type: application/json" \ -d '{ "keyType": "string", "keySuffix": "string", "keyIndex": 0, "rateLimitedUntil": "2019-08-24T14:15:22Z" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/keys/report-rate-limit-windows" \ -H "Content-Type: application/json" \ -d '{ "keyType": "string", "keySuffix": "string", "keyIndex": 0, "windows": { "property1": { "status": "string", "lastSeenAt": "2019-08-24T14:15:22Z" }, "property2": { "status": "string", "lastSeenAt": "2019-08-24T14:15:22Z" } } }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/keys/report-usage" \ -H "Content-Type: application/json" \ -d '{ "keyType": "string", "keySuffix": "string", "keyIndex": 0 }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
Response Body
curl -X GET "http://localhost:3013/api/keys/status"