Agent SwarmAPI Keys
API Keys API endpoints
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
keyType*string
totalKeys*integer
Range
1 <= valuescope?string
scopeId?string
Response Body
curl -X GET "http://localhost:3013/api/keys/available?keyType=string&totalKeys=1"Empty
Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
keyType?string
Response Body
curl -X GET "http://localhost:3013/api/keys/costs"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
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" }'Empty
Empty
Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
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" }'Empty
Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
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 }'Empty
Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
keyType?string
scope?string
scopeId?string
Response Body
curl -X GET "http://localhost:3013/api/keys/status"Empty
Empty