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

# Metadata

Every successful API response includes a `meta` block alongside your requested data. The metadata provides contextual information about the API request such as execution timestamps, authentication details, request identifiers, and remaining credit balances.

## Example Payload

```json theme={null}
{
  "status": "success",
  "company_number": "00445790",
  "data": {},
  "meta": {
    "api_key": "1591e4...23c1ce",
    "api_key_name": "My API Key",
    "request_id": "1464819",
    "request_path": "/company/12345678/vat",
    "timestamp": "2026-09-18T18:22:54+01:00",
    "credits": {
      "cost": 5,
      "remaining": 971
    }
  }
}
```

## Reference

<table>
  <colgroup>
    <col width="151" />

    <col width="561" />
  </colgroup>

  <thead>
    <tr>
      <th>Field</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>api\_key</td>
      <td>A masked version of the API key used to make the request.</td>
    </tr>

    <tr>
      <td>api\_key\_name</td>
      <td>The memorable name assigned to your API key in the dashboard.</td>
    </tr>

    <tr>
      <td>request\_id</td>
      <td>A unique identifier for the specific API request. Quote this ID when contacting support regarding a specific query.</td>
    </tr>

    <tr>
      <td>request\_path</td>
      <td>The exact endpoint path that was executed.</td>
    </tr>

    <tr>
      <td>timestamp</td>
      <td>The ISO 8601 formatted date and time when the request was processed.</td>
    </tr>

    <tr>
      <td>credits.cost</td>
      <td>The total number of API credits deducted for this request.</td>
    </tr>

    <tr>
      <td>credits.remaining</td>
      <td>The balance of credits available in your account after deducting the request cost.</td>
    </tr>
  </tbody>
</table>