API Documentation

Explore the complete API reference for AgentGrid. Integrate AI agents seamlessly into your applications with our RESTful API.

RESTful APIJSON FormatReal-time Responses

API Base URL

https://app.agentgrid.ai

Authentication

All API requests require authentication using an API key. Include your API key in the request body or as a query parameter.

💡 Sign in to create API keys and access interactive features.

REST API Documentation

Complete API reference with interactive testing capabilities.

Available Endpoints'

POST/api/chat

Chat with agent using legacy endpoint (RECOMMENDED)

GET/api/v1/agents

List all agents for your organization

POST/api/v1/agents

Create a new agent

PUT/api/v1/agents/{id}

Update an existing agent

GET/api/v1/agents/{id}

Get detailed information about a specific agent

GET/api/v1/agents/{id}/api-keys

List API keys for an agent

POST/api/v1/agents/{id}/api-keys

Create a new API key for an agent

GET/api/v1/agents/{id}/analytics

Get analytics and usage statistics for an agent

GET/api/v1/agents/{id}/knowledge

Get the knowledge base for an agent

PUT/api/v1/agents/{id}/knowledge

Update the knowledge base for an agent

DELETE/api/v1/agents/{id}

Delete an agent

GET/api/v1/agents/{id}/chat

Get chat history for an agent

DELETE/api/v1/agents/{id}/api-keys/{keyId}

Revoke/delete an API key

Quick Start Guide

1. Get Your API Key

Create an API key for your agent above to authenticate requests.

2. Send a Chat Message

Use the chat endpoint to send messages to your agent:

curl -X POST "https://your-domain.com/api/v1/agents//chat" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello, how can you help me?",
    "apiKey": "your-api-key-here"
  }'

3. Get Agent Details

Retrieve agent details and configuration:

curl -X GET "https://your-domain.com/api/v1/agents/" \
  -H "Content-Type: application/json"