get_endpoint

Returns the full documentation of one endpoint. Everything your published endpoint page says: its description, parameters, request body fields, responses and code examples, as text an agent can read.

When it's listed

On every server, in every tool mode. A tool group can leave the documentation tools out.

Arguments

slugstringrequired

The endpoint's slug, as search_docs or list_endpoints printed it.

projectIdstring

The project to read. Leave it out: the server already knows its project, and passing another one reads that project instead.

Returns

The endpoint's title, API version and METHOD /path, then a section each for parameters, the request body, responses and code examples, leaving out any it doesn't have. A deprecated endpoint says so first.

Hints

The annotations a client reads to decide what may run without asking the user.

Hint	Value	When true, it means
`readOnlyHint`	`true`	It doesn't change anything
`destructiveHint`	`false`	It can change or delete data
`idempotentHint`	`true`	Calling it twice does no more than once
`openWorldHint`	`true`	It reaches outside the server, over the network

Examples

Read an endpoint

{
  "name": "get_endpoint",
  "arguments": {
    "slug": "post-customers"
  }
}

# Create a customer
**Version:** 2024-08-01
**Project:** Acme API
`POST /customers`

## Request body (application/json)
- **name** (string) *(required)*
- **email** (string) *(required)*
- **currency** (string)
- **address** (object)
- **metadata** (object)

## Responses
- **201**: The customer that was created.
- **400**: The request was malformed or failed validation.
- **401**: The API key is missing, malformed or revoked.
- **409**: A customer with that email already exists.

## Code Examples
```curl
curl -X POST 'https://api.acme.com/v1/customers' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{"name":"Example Name","email":"user@example.com","currency":"USD","address":{"line1":"example_value","line2":"example_value","city":"example_value","postal_code":"example_value","country":"GB"},"metadata":{}}'
```
…

Documentation tools: search_docs, list_endpoints, get_guide, get_sdk_methods, list_sdks, get_changelog.
Documentation tools: how agents use these together.
Search and AI chat: the same search, for people on your docs site.