API Reference

Complete API documentation with examples, request/response formats, and authentication details.

Getting Started

The AGNT5 API is organized around REST principles. Our API accepts JSON requests and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs.

Base URL


https://api.agnt5.dev/v1

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header.

Header Format


Authorization: Bearer YOUR_API_KEY

API Endpoints

Contacts

Manage contacts in your workflows. Create, read, update, and delete contact information.

POST /contacts Create a contact

GET /contacts Get all contacts

PUT /contacts/:id Update a contact

DELETE /contacts/:id Delete a contact

HTTP Status Codes

AGNT5 uses conventional HTTP response codes to indicate success or failure.

Success Codes

200 OK - Request succeeded

201 Created - Resource created

204 No Content - Deleted successfully

Error Codes

400 Bad Request - Invalid parameters

401 Unauthorized - Invalid API key

404 Not Found - Resource not found

500 Server Error - Something went wrong