---
title: "Get an invocation, provider attempt and quota settlement"
description: "GET /admin/v1/invocations/{invocationId} — Get an invocation, provider attempt and quota settlement"
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an invocation, provider attempt and quota settlement

## Endpoint

```http
GET /admin/v1/invocations/{invocationId}
```

Operation ID: `getInvocation`

## Authentication

Send a Nexus Management Key as `Authorization: Bearer <management-key>`. This credential is control-plane only.

## Idempotency

This operation does not declare an `Idempotency-Key` requirement in the accepted OpenAPI contract.

## Request

### Parameters

| Name           | Location | Required | Schema   | Description |
| -------------- | -------- | -------- | -------- | ----------- |
| `invocationId` | path     | Yes      | `string` | —           |

### Body

_This operation has no request body._

## Responses

| Status | Description | Content type     | Schema          |
| ------ | ----------- | ---------------- | --------------- |
| `200`  | —           | application/json | `InvocationDto` |

Only responses explicitly declared by the accepted Admin OpenAPI contract are shown. The current contract does not declare operation-specific error bodies; the SDK preserves any non-success status and body in [`AdminApiError`](/management-sdk/error-handling).

### `200` application/json schema

Type: `InvocationDto`

| Field                          | Required | Type                   | Description                                  |
| ------------------------------ | -------- | ---------------------- | -------------------------------------------- |
| `id`                           | Yes      | `string`               | —                                            |
| `requestId`                    | Yes      | `string`               | —                                            |
| `traceId`                      | No       | `string`               | —                                            |
| `workspaceId`                  | Yes      | `string`               | —                                            |
| `workspaceAccessId`            | Yes      | `string`               | —                                            |
| `requestedModel`               | Yes      | `string`               | —                                            |
| `providerConnectionId`         | Yes      | `string`               | —                                            |
| `status`                       | Yes      | `string`               | —                                            |
| `quotaUnits`                   | Yes      | `string`               | —                                            |
| `startedAt`                    | Yes      | `string / date-time`   | —                                            |
| `firstTokenAt`                 | No       | `string / date-time`   | —                                            |
| `completedAt`                  | No       | `string / date-time`   | —                                            |
| `totalLatencyMs`               | No       | `number`               | —                                            |
| `nexusLatencyMs`               | No       | `number`               | Gateway time outside the Provider attempt.   |
| `providerLatencyMs`            | No       | `number`               | —                                            |
| `totalTtftMs`                  | No       | `number`               | —                                            |
| `nexusTtftMs`                  | No       | `number`               | Gateway time before the Provider first byte. |
| `providerTtftMs`               | No       | `number`               | —                                            |
| `attempt`                      | No       | `InvocationAttemptDto` | —                                            |
| `attempt.id`                   | Yes      | `string`               | —                                            |
| `attempt.sequence`             | Yes      | `number`               | —                                            |
| `attempt.providerConnectionId` | Yes      | `string`               | —                                            |
| `attempt.upstreamModel`        | Yes      | `string`               | —                                            |
| `attempt.status`               | Yes      | `string`               | —                                            |
| `attempt.startedAt`            | Yes      | `string / date-time`   | —                                            |
| `attempt.firstTokenAt`         | No       | `string / date-time`   | —                                            |
| `attempt.completedAt`          | No       | `string / date-time`   | —                                            |
| `attempt.durationMs`           | No       | `number`               | —                                            |
| `attempt.httpStatus`           | No       | `number`               | —                                            |
| `attempt.errorCode`            | No       | `string`               | —                                            |
| `usageEvents`                  | No       | `array<UsageEventDto>` | —                                            |

## Examples

### TypeScript Management SDK

`NexusAdminClient.getInvocation` uses `AdminOperationInput<"getInvocation">` and returns `Promise<AdminOperationOutput<"getInvocation">>`.

```ts
import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: 'https://nexus.microvoid.io',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

const result = await nexus.getInvocation({
  path: {
    invocationId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});
```

### Fetch

```ts
const response = await fetch('https://nexus.microvoid.io/admin/v1/invocations/533c4e1e-2823-4349-86b9-d6f1a869a2ca', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
  },
});

if (!response.ok) throw new Error(`Nexus request failed: ${response.status}`);
```

### curl

```bash
curl --request GET \
  "https://nexus.microvoid.io/admin/v1/invocations/533c4e1e-2823-4349-86b9-d6f1a869a2ca" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"
```

## Related guide

- [Reserve, settle, and release](/docs/control-plans-and-quota/reserve-settle-release)
- [API Reference overview](/api-reference)

Source: https://nexus.microvoid.io/api-reference/admin/usage-and-audit/get-invocation/index.mdx