> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orthogonal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Details

> Get full parameter information for an endpoint

Get complete details about a specific API endpoint, including all parameters, types, and descriptions.

## Request

<ParamField body="api" type="string" required>
  API slug from search results (e.g., "apollo", "linkup", "olostep")
</ParamField>

<ParamField body="path" type="string" required>
  Endpoint path (e.g., "/v1/people/match", "/v1/search")
</ParamField>

## Response

```json theme={null}
{
  "success": true,
  "api": {
    "name": "Apollo.io",
    "slug": "apollo",
    "description": "B2B lead enrichment and contact database",
    "baseUrl": "https://api.apollo.io",
    "verified": true
  },
  "endpoint": {
    "path": "/v1/people/match",
    "method": "POST",
    "description": "Enrich a person by email, name, or LinkedIn URL",
    "price": "$0.03",
    "isPayable": true,
    "docsUrl": "https://apolloio.github.io/apollo-api-docs",
    "bodyType": "object",
    "pathParams": [],
    "queryParams": [],
    "bodyParams": [
      {
        "name": "email",
        "type": "string",
        "required": false,
        "description": "Email address to enrich"
      },
      {
        "name": "first_name",
        "type": "string",
        "required": false,
        "description": "First name of the person"
      },
      {
        "name": "last_name",
        "type": "string",
        "required": false,
        "description": "Last name of the person"
      },
      {
        "name": "organization_name",
        "type": "string",
        "required": false,
        "description": "Company name"
      },
      {
        "name": "linkedin_url",
        "type": "string",
        "required": false,
        "description": "LinkedIn profile URL"
      }
    ]
  },
  "usage": {
    "runApi": "POST /v1/run with {\"api\": \"apollo\", \"path\": \"/v1/people/match\", ...}",
    "x402": "https://x402.orth.sh/apollo/v1/people/match"
  }
}
```

### Response Fields

| Field                  | Description                                                 |
| ---------------------- | ----------------------------------------------------------- |
| `api`                  | API metadata (name, slug, description, verification status) |
| `endpoint.pathParams`  | URL path parameters like `{id}`                             |
| `endpoint.queryParams` | Query string parameters                                     |
| `endpoint.bodyParams`  | Request body parameters                                     |
| `endpoint.price`       | Cost per call (or "dynamic" for variable pricing)           |
| `usage`                | Example URLs for calling this endpoint                      |

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST 'https://api.orthogonal.com/v1/details' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -H 'Content-Type: application/json' \
    -d '{
      "api": "apollo",
      "path": "/v1/people/match"
    }'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://api.orthogonal.com/v1/details', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.ORTHOGONAL_API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      api: 'apollo',
      path: '/v1/people/match'
    })
  });

  const { api, endpoint } = await response.json();
  console.log(`Price: ${endpoint.price}`);
  console.log('Parameters:', endpoint.bodyParams);
  ```

  ```python Python theme={null}
  import requests
  import os

  response = requests.post(
      'https://api.orthogonal.com/v1/details',
      headers={'Authorization': f'Bearer {os.environ["ORTHOGONAL_API_KEY"]}'},
      json={'api': 'apollo', 'path': '/v1/people/match'}
  )

  data = response.json()
  print(f"Price: {data['endpoint']['price']}")
  print('Parameters:', data['endpoint']['bodyParams'])
  ```
</CodeGroup>

## Use Case: Building Dynamic Requests

Use details to construct valid API calls programmatically:

```javascript theme={null}
// 1. Get endpoint details
const details = await getDetails('apollo', '/v1/people/match');

// 2. Build request body from available params
const body = {};
for (const param of details.endpoint.bodyParams) {
  if (userInput[param.name]) {
    body[param.name] = userInput[param.name];
  }
}

// 3. Make the API call
const result = await run('apollo', '/v1/people/match', { body });
```