Skip to main content

Agents API Reference

Overview​

The Agents API allows you to create, manage, and interact with Gentic agents.

Endpoints​

List Agents​

GET /agents

Returns a list of all agents.

Create Agent​

POST /agents

Creates a new agent.

Get Agent​

GET /agents/{agentId}

Retrieves details of a specific agent.

Update Agent​

PUT /agents/{agentId}

Updates an existing agent.

Delete Agent​

DELETE /agents/{agentId}

Deletes an agent.

Converse with Agent​

POST /agents/{agentId}/converse

Initiates a conversation with an agent.

Request/Response Examples​

Create Agent​

{
  "name": "Support Agent",
  "description": "Customer support assistant",
  "model": "gpt-4",
  "temperature": 0.7,
  "maxTokens": 1000
}

Converse with Agent​

{
  "message": "How can I reset my password?",
  "context": {
    "userId": "user123",
    "sessionId": "session456"
  }
}

Error Codes​

  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 429: Too Many Requests
  • 500: Internal Server Error

Rate Limits​

  • 100 requests per minute per API key
  • 1000 requests per hour per API key

Next Steps​