# API Reference

> Every HTTP operation on the sference API, generated from the OpenAPI specification. Each operation also has its own Markdown page (append `.md` to any URL).

Machine-readable spec: https://sference.com/openapi.json
HTML version: https://sference.com/docs/api-reference

## Inference API

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/v1/auth/me` | [Me](https://sference.com/docs/api-reference/inference-api/V1AuthMeMe.md) |
| `GET` | `/v1/responses/{response_id}` | [GetResponse](https://sference.com/docs/api-reference/inference-api/V1ResponsesResponseIdGetResponse.md) |
| `DELETE` | `/v1/responses/{response_id}` | [CancelResponse](https://sference.com/docs/api-reference/inference-api/V1ResponsesResponseIdCancelResponse.md) |
| `GET` | `/v1/responses` | [ListResponses](https://sference.com/docs/api-reference/inference-api/V1ResponsesListResponses.md) |
| `POST` | `/v1/responses` | [CreateResponse](https://sference.com/docs/api-reference/inference-api/V1ResponsesCreateResponse.md) |
| `GET` | `/v1/responses/events` | [ListResponseEvents](https://sference.com/docs/api-reference/inference-api/V1ResponsesEventsListResponseEvents.md) |
| `POST` | `/v1/chat/completions` | [CreateChatCompletion](https://sference.com/docs/api-reference/inference-api/V1ChatCompletionsCreateChatCompletion.md) |
| `POST` | `/v1/embeddings` | [CreateEmbedding](https://sference.com/docs/api-reference/inference-api/V1EmbeddingsCreateEmbedding.md) |
| `POST` | `/v1/messages` | [CreateMessage](https://sference.com/docs/api-reference/inference-api/V1MessagesCreateMessage.md) |
| `GET` | `/v1/models` | [ListModels](https://sference.com/docs/api-reference/inference-api/V1ModelsListModels.md) |

## Batch API

| Method | Path | Operation |
| --- | --- | --- |
| `POST` | `/v1/batches/{batch_id}/cancel` | [CancelBatch](https://sference.com/docs/api-reference/batch-api/V1BatchesBatchIdCancelCancelBatch.md) |
| `GET` | `/v1/batches` | [ListBatches](https://sference.com/docs/api-reference/batch-api/V1BatchesListBatches.md) |
| `POST` | `/v1/batches` | [CreateBatch](https://sference.com/docs/api-reference/batch-api/V1BatchesCreateBatch.md) |
| `GET` | `/v1/batches/{batch_id}` | [GetBatch](https://sference.com/docs/api-reference/batch-api/V1BatchesBatchIdGetBatch.md) |
| `GET` | `/v1/batches/{batch_id}/results` | [GetResults](https://sference.com/docs/api-reference/batch-api/V1BatchesBatchIdResultsGetResults.md) |
| `GET` | `/v1/batches/{batch_id}/results.jsonl` | [GetResultsJsonl](https://sference.com/docs/api-reference/batch-api/V1BatchesBatchIdResultsJsonlGetResultsJsonl.md) |

## Model Catalog

| Method | Path | Operation |
| --- | --- | --- |
| `POST` | `/control/v1/models/custom` | [CreateCustomModel](https://sference.com/docs/api-reference/model-catalog/ControlV1ModelsCustomCreateCustomModel.md) |
| `DELETE` | `/control/v1/models/custom` | [DeleteCustomModel](https://sference.com/docs/api-reference/model-catalog/ControlV1ModelsCustomDeleteCustomModel.md) |
| `GET` | `/control/v1/models/catalog` | [GetCatalog](https://sference.com/docs/api-reference/model-catalog/ControlV1ModelsCatalogGetCatalog.md) |
| `POST` | `/control/v1/models/request-deployment` | [RequestModelDeployment](https://sference.com/docs/api-reference/model-catalog/ControlV1ModelsRequestDeploymentRequestModelDeployment.md) |
| `GET` | `/control/v1/models/search` | [SearchModels](https://sference.com/docs/api-reference/model-catalog/ControlV1ModelsSearchSearchModels.md) |

## Deployments

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/control/v1/deployments` | [ListDeployments](https://sference.com/docs/api-reference/deployments/ControlV1DeploymentsListDeployments.md) |
| `POST` | `/control/v1/deployments` | [CreateDeployment](https://sference.com/docs/api-reference/deployments/ControlV1DeploymentsCreateDeployment.md) |
| `DELETE` | `/control/v1/deployments/{deployment_id}` | [DeleteDeployment](https://sference.com/docs/api-reference/deployments/ControlV1DeploymentsDeploymentIdDeleteDeployment.md) |

## Teams

| Method | Path | Operation |
| --- | --- | --- |
| `POST` | `/control/v1/teams/me/members` | [AddMember](https://sference.com/docs/api-reference/teams/ControlV1TeamsMeMembersAddMember.md) |
| `GET` | `/control/v1/teams/me` | [GetMe](https://sference.com/docs/api-reference/teams/ControlV1TeamsMeGetMe.md) |
| `PATCH` | `/control/v1/teams/me` | [UpdateMe](https://sference.com/docs/api-reference/teams/ControlV1TeamsMeUpdateMe.md) |
| `PATCH` | `/control/v1/teams/me/members/{user_id}` | [UpdateMemberRole](https://sference.com/docs/api-reference/teams/ControlV1TeamsMeMembersUserIdUpdateMemberRole.md) |
| `DELETE` | `/control/v1/teams/me/members/{user_id}` | [RemoveMember](https://sference.com/docs/api-reference/teams/ControlV1TeamsMeMembersUserIdRemoveMember.md) |

## Activity

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/control/v1/activity/{request_id}` | [GetActivityDetail](https://sference.com/docs/api-reference/activity/ControlV1ActivityRequestIdGetActivityDetail.md) |
| `GET` | `/control/v1/activity` | [ListActivity](https://sference.com/docs/api-reference/activity/ControlV1ActivityListActivity.md) |
| `GET` | `/control/v1/activity/models` | [ListModels](https://sference.com/docs/api-reference/activity/ControlV1ActivityModelsListModels.md) |

## Billing

| Method | Path | Operation |
| --- | --- | --- |
| `POST` | `/control/v1/billing/invoices` | [CreateInvoice](https://sference.com/docs/api-reference/billing/ControlV1BillingInvoicesCreateInvoice.md) |
| `POST` | `/control/v1/billing/topups` | [CreateTopup](https://sference.com/docs/api-reference/billing/ControlV1BillingTopupsCreateTopup.md) |
| `GET` | `/control/v1/billing/summary` | [GetSummary](https://sference.com/docs/api-reference/billing/ControlV1BillingSummaryGetSummary.md) |
| `GET` | `/control/v1/billing/transactions` | [GetTransactions](https://sference.com/docs/api-reference/billing/ControlV1BillingTransactionsGetTransactions.md) |

## Usage

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/control/v1/usage/daily` | [GetDaily](https://sference.com/docs/api-reference/usage/ControlV1UsageDailyGetDaily.md) |
| `GET` | `/control/v1/usage/summary` | [GetSummary](https://sference.com/docs/api-reference/usage/ControlV1UsageSummaryGetSummary.md) |

Source: https://sference.com/docs/api-reference