# MKA1: English API Reference ## API Reference - [English / API Reference / Usage and budgets (45 pages)](https://docs.mka1.com/_llms/en/api-reference/usage-and-budgets.txt): Documentation for English / API Reference / Usage and budgets. ### Overview - [API overview](https://docs.mka1.com/api-reference/introduction.md) ### Responses and conversations #### Responses - [Create an agent-powered response with tool support](https://docs.mka1.com/api-reference/responses/create-an-agent-powered-response-with-tool-support.md): Creates a new AI agent response using advanced language models with autonomous tool usage capabilities. - [List all responses with pagination](https://docs.mka1.com/api-reference/responses/list-all-responses-with-pagination.md): Retrieves a paginated list of all agent responses for the authenticated user. - [Retrieve response by ID with status and results](https://docs.mka1.com/api-reference/responses/retrieve-response-by-id-with-status-and-results.md): Retrieves a previously created agent response by its unique ID. When stream=true, returns Server-Sent Events for real-time updates on in-progress background responses. - [Update a response](https://docs.mka1.com/api-reference/responses/update-a-response.md): Update a response's metadata. - [Permanently delete a response and its data](https://docs.mka1.com/api-reference/responses/permanently-delete-a-response-and-its-data.md): Permanently deletes an agent response and all associated data. - [Cancel an in-progress background response](https://docs.mka1.com/api-reference/responses/cancel-an-in-progress-background-response.md): Cancels an agent response that is currently processing in the background. - [Wake a sleeping background response](https://docs.mka1.com/api-reference/responses/wake-a-sleeping-background-response.md): Interrupts a short sleep tool call on an in-progress background response by providing follow-up input. Wake delivery is polled by the sleeping agent and may take up to one second. - [List paginated input items for a response](https://docs.mka1.com/api-reference/responses/list-paginated-input-items-for-a-response.md): Retrieves a paginated list of all input items provided when creating the specified agent response. - [Compact a conversation](https://docs.mka1.com/api-reference/responses/compact-a-conversation.md): Creates a compacted summary of the conversation history for a response, reducing context size while preserving key information. Returns a compacted response object. #### Conversations - [Create a conversation](https://docs.mka1.com/api-reference/conversations/create-a-conversation.md): Create a conversation to store and retrieve conversation state across Response API calls. - [List conversations](https://docs.mka1.com/api-reference/conversations/list-conversations.md): List all conversations for the authenticated user with pagination support. - [Retrieve a conversation](https://docs.mka1.com/api-reference/conversations/retrieve-a-conversation.md): Get a conversation by ID. - [Update a conversation](https://docs.mka1.com/api-reference/conversations/update-a-conversation.md): Update a conversation's metadata. - [Delete a conversation](https://docs.mka1.com/api-reference/conversations/delete-a-conversation.md): Delete a conversation. Items in the conversation will not be deleted. - [List conversation items](https://docs.mka1.com/api-reference/conversations/list-conversation-items.md): List all items for a conversation with the given ID. - [Create conversation items](https://docs.mka1.com/api-reference/conversations/create-conversation-items.md): Create items in a conversation with the given ID. - [Delete multiple conversation items](https://docs.mka1.com/api-reference/conversations/delete-multiple-conversation-items.md): Delete multiple items from a conversation with the given ID. - [Retrieve a conversation item](https://docs.mka1.com/api-reference/conversations/retrieve-a-conversation-item.md): Get a single item from a conversation with the given IDs. - [Delete a conversation item](https://docs.mka1.com/api-reference/conversations/delete-a-conversation-item.md): Delete an item from a conversation with the given ID. ### Models and routing #### Models - [List available models](https://docs.mka1.com/api-reference/models/list-available-models.md): Lists the currently available models. Provides basic information about each model including its ID and owner. - [Retrieve a model](https://docs.mka1.com/api-reference/models/retrieve-a-model.md): Retrieves a model instance, providing basic information about the model such as the owner and supported capabilities. - [List the organization's model catalog](https://docs.mka1.com/api-reference/models/list-the-organizations-model-catalog.md): Lists all BYO, serving, and cluster-access definitions with activation state, blocker, health, and price preview. - [Define a BYO catalog model](https://docs.mka1.com/api-reference/models/define-a-byo-catalog-model.md): Creates an API-owned BYO definition without activating its name. - [Update a BYO catalog model](https://docs.mka1.com/api-reference/models/update-a-byo-catalog-model.md): Updates an API-owned BYO definition; yaml-origin entries are file-managed and immutable through this API. - [Remove a BYO catalog model](https://docs.mka1.com/api-reference/models/remove-a-byo-catalog-model.md): Withdraws a BYO definition and deactivates it only when the active name is sourced from that BYO lineage. - [Check a BYO catalog model's health](https://docs.mka1.com/api-reference/models/check-a-byo-catalog-models-health.md): Probes an available BYO definition whether or not it is active. - [List an organization's cluster model access](https://docs.mka1.com/api-reference/models/list-an-organizations-cluster-model-access.md): Cluster operator view of an org's available cluster catalog entries and their activation state. - [Add cluster model access for an organization](https://docs.mka1.com/api-reference/models/add-cluster-model-access-for-an-organization.md): Idempotently adds availability without revoking any model names. Set activate to true to also activate every requested model from the cluster source in the target organization. Grants and activations are atomic per request; a name active from another source returns 409 without changing access or act… - [Replace an organization's cluster model access](https://docs.mka1.com/api-reference/models/replace-an-organizations-cluster-model-access.md): Serializable full replacement; revoked active cluster names are deactivated and their org price rows are closed. - [List organizations with access to a cluster model](https://docs.mka1.com/api-reference/models/list-organizations-with-access-to-a-cluster-model.md): Cluster operator reverse lookup showing availability and activation for one cluster catalog id. - [List the organization's active model registry](https://docs.mka1.com/api-reference/models/list-the-organizations-active-model-registry.md): Single management view of every active name with source-qualified definition, health, price, and activation audit details. - [Activate a catalog entry](https://docs.mka1.com/api-reference/models/activate-a-catalog-entry.md): Claims a model name from one catalog source. Re-activation from the same source is idempotent; a different holder returns 409. - [Deactivate a model registry name](https://docs.mka1.com/api-reference/models/deactivate-a-model-registry-name.md): Idempotently removes the active name and closes its org-scope price rows without touching the catalog definition. - [List this org's auto-model overrides](https://docs.mka1.com/api-reference/models/list-this-orgs-auto-model-overrides.md): Returns every endpoint for which this org has set its own `"auto"` target. Endpoints not listed fall through to the operator's YAML defaults. - [Set this org's auto policy for an endpoint](https://docs.mka1.com/api-reference/models/set-this-orgs-auto-policy-for-an-endpoint.md): Stores either the existing direct `{ endpoint → model_id }` alias or a judge policy with candidate models. Judge routing is supported for responses, completions, transcriptions, and TTS. All configured models must be active when written; revoked candidates are filtered at request time, while an unav… - [Clear this org's auto-model override for an endpoint](https://docs.mka1.com/api-reference/models/clear-this-orgs-auto-model-override-for-an-endpoint.md): Remove a substituição por org para o endpoint. As solicitações subsequentes `model: "auto"` passam a utilizar o padrão YAML do operador novamente. - [Get the cluster currency](https://docs.mka1.com/api-reference/models/get-the-cluster-currency.md): Returns the single cluster-wide ISO-4217 currency code (null if not set). - [Set the cluster currency](https://docs.mka1.com/api-reference/models/set-the-cluster-currency.md): Sets the cluster-wide currency. Changing it does not auto-convert existing prices. - [List cluster-default model prices](https://docs.mka1.com/api-reference/models/list-cluster-default-model-prices.md): Without `model`, lists every model's current cluster-default price. With `model`, returns that model's full dated history. - [Set a cluster-default model price](https://docs.mka1.com/api-reference/models/set-a-cluster-default-model-price.md): Upserts the cluster-default price for a model as a new dated version. `rates` is a flexible metric→rate map; omitted metrics are not charged. - [Clear a cluster-default model price](https://docs.mka1.com/api-reference/models/clear-a-cluster-default-model-price.md): Closes the cluster-default price. Active cluster lineage then uses an org override or becomes unpriced ($0). - [List an org's price overrides](https://docs.mka1.com/api-reference/models/list-an-orgs-price-overrides.md): Without `model`, lists the org's current overrides. With `model`, returns that override's dated history. - [Set an org price override](https://docs.mka1.com/api-reference/models/set-an-org-price-override.md): Upserts a dated per-org price. Cluster lineage falls back to the cluster default; BYO and serving lineage become unpriced when no org row exists. - [Clear an org price override](https://docs.mka1.com/api-reference/models/clear-an-org-price-override.md): Closes a per-org price. Only active cluster lineage can then fall back to the cluster default. - [List effective prices for the caller's models](https://docs.mka1.com/api-reference/models/list-effective-prices-for-the-callers-models.md): For every active model, returns its registry-aware price: an org row, a cluster default for cluster lineage, or unpriced ($0). Also lists the `auto` routing alias, priced at the per-metric maximum across every model it can be billed as (`resolves_to`): a judge policy's active candidates, or the dire… #### Embeddings - [List available embedding models](https://docs.mka1.com/api-reference/embeddings/list-available-embedding-models.md): Returns a list of available embedding models with their limits. Use this endpoint to discover which models are available and their constraints (batch size, input length) before making embedding requests. - [Create text embeddings](https://docs.mka1.com/api-reference/embeddings/create-text-embeddings.md): Generates vector embeddings for single or multiple text inputs. Returns floating-point vectors along with token usage statistics. #### Text Classification - [Classify text into predefined categories](https://docs.mka1.com/api-reference/text-classification/classify-text-into-predefined-categories.md): Classifies text content into one of the provided predefined labels. ### Images and audio #### Images - [Generate images from text descriptions](https://docs.mka1.com/api-reference/images/generate-images-from-text-descriptions.md): Creates AI-generated images from text descriptions. #### Speech - [Speech to text transcription](https://docs.mka1.com/api-reference/speech/speech-to-text-transcription.md): Convert audio to text using advanced speech recognition. - [Text to speech](https://docs.mka1.com/api-reference/speech/text-to-speech.md): Convert text to speech with automatic language detection. - [Streaming text to speech](https://docs.mka1.com/api-reference/speech/streaming-text-to-speech.md): Convert text to speech with real-time streaming audio delivery. - [Generate LiveKit room token](https://docs.mka1.com/api-reference/speech/generate-livekit-room-token.md): Generates a LiveKit access token for joining a real-time voice room. The token includes encrypted credentials and model configuration for the voice agent. - [List text-to-speech history](https://docs.mka1.com/api-reference/speech/list-text-to-speech-history.md): List stored text-to-speech generations for the authenticated user, newest first by default. - [Retrieve text-to-speech history item](https://docs.mka1.com/api-reference/speech/retrieve-text-to-speech-history-item.md): Returns metadata for a stored text-to-speech generation. - [Delete text-to-speech history item](https://docs.mka1.com/api-reference/speech/delete-text-to-speech-history-item.md): Deletes a stored text-to-speech generation. The audio blob is content-addressed and may be shared, so it is left in storage. - [Retrieve text-to-speech audio](https://docs.mka1.com/api-reference/speech/retrieve-text-to-speech-audio.md): Returns the stored audio for a text-to-speech generation as a binary response. - [List speech-to-text history](https://docs.mka1.com/api-reference/speech/list-speech-to-text-history.md): List stored transcriptions for the authenticated user, newest first by default. - [Retrieve speech-to-text history item](https://docs.mka1.com/api-reference/speech/retrieve-speech-to-text-history-item.md): Returns metadata for a stored transcription. - [Delete speech-to-text history item](https://docs.mka1.com/api-reference/speech/delete-speech-to-text-history-item.md): Deletes a stored transcription. The audio blob is content-addressed and may be shared, so it is left in storage. - [Retrieve speech-to-text audio](https://docs.mka1.com/api-reference/speech/retrieve-speech-to-text-audio.md): Returns the stored input audio for a transcription as a binary response. ### Files and retrieval #### Files - [Upload file](https://docs.mka1.com/api-reference/files/upload-file.md): Upload a file that can be used with Assistants, Vector Stores, and other features. Files are uploaded to S3 for durable storage. - [List files](https://docs.mka1.com/api-reference/files/list-files.md): Returns a list of files that have been uploaded. - [Retrieve file](https://docs.mka1.com/api-reference/files/retrieve-file.md): Returns information about a specific file. - [Delete file](https://docs.mka1.com/api-reference/files/delete-file.md): Delete a file from storage. The file is first removed from every vector store it is attached to, embeddings included, so it no longer appears in vector store search or `file_search` results. If that cannot finish, the file is kept and the request fails; retrying completes the deletion. Returns 400 `… - [Retrieve file content](https://docs.mka1.com/api-reference/files/retrieve-file-content.md): Returns the raw binary contents of the specified file with appropriate Content-Type header. #### Vector Stores - [Create a vector store](https://docs.mka1.com/api-reference/vector-stores/create-a-vector-store.md): Creates a new vector store for storing and searching through document embeddings. - [List vector stores](https://docs.mka1.com/api-reference/vector-stores/list-vector-stores.md): Retrieves a paginated list of all vector stores for the authenticated user. - [Retrieve a vector store](https://docs.mka1.com/api-reference/vector-stores/retrieve-a-vector-store.md): Retrieves a vector store by its ID. Returns 410 once the vector store has expired. - [Modify a vector store](https://docs.mka1.com/api-reference/vector-stores/modify-a-vector-store.md): Updates the properties of an existing vector store. Returns 410 once the vector store has expired. - [Delete a vector store](https://docs.mka1.com/api-reference/vector-stores/delete-a-vector-store.md): Permanently deletes a vector store and its associated embeddings. - [Search a vector store](https://docs.mka1.com/api-reference/vector-stores/search-a-vector-store.md): Performs semantic search within a vector store to find the most relevant document chunks for a query. Returns 410 once the vector store has expired. - [Add a file to a vector store](https://docs.mka1.com/api-reference/vector-stores/add-a-file-to-a-vector-store.md): Adds a file to a vector store for semantic search indexing. Returns 410 once the vector store has expired. - [List files in a vector store](https://docs.mka1.com/api-reference/vector-stores/list-files-in-a-vector-store.md): Retrieves a paginated list of all files in a specific vector store. Returns 410 once the vector store has expired. - [Retrieve a vector store file](https://docs.mka1.com/api-reference/vector-stores/retrieve-a-vector-store-file.md): Retrieves detailed information about a specific file within a vector store. Returns 410 once the vector store has expired. - [Update file attributes](https://docs.mka1.com/api-reference/vector-stores/update-file-attributes.md): Updates the metadata attributes attached to a file within a vector store. Returns 410 once the vector store has expired. - [Remove file from vector store](https://docs.mka1.com/api-reference/vector-stores/remove-file-from-vector-store.md): Removes a file from a vector store and deletes its associated embeddings. If the file is no longer attached but the vector store still holds embeddings for it (for example, left behind by an earlier file deletion), those embeddings are deleted and the request succeeds, provided the file was deleted… - [Retrieve parsed file content](https://docs.mka1.com/api-reference/vector-stores/retrieve-parsed-file-content.md): Retrieves the complete parsed contents of a file within a vector store. Returns 410 once the vector store has expired. - [Batch add multiple files to vector store](https://docs.mka1.com/api-reference/vector-stores/batch-add-multiple-files-to-vector-store.md): Adds multiple files to a vector store in a single batch operation. Returns 410 once the vector store has expired. - [Retrieve file batch status](https://docs.mka1.com/api-reference/vector-stores/retrieve-file-batch-status.md): Retrieves the status of a specific file batch operation within a vector store. Returns 410 once the vector store has expired. - [Cancel batch file processing](https://docs.mka1.com/api-reference/vector-stores/cancel-batch-file-processing.md): Cancels an in-progress file batch operation. Returns 410 once the vector store has expired. - [List files in a batch](https://docs.mka1.com/api-reference/vector-stores/list-files-in-a-batch.md): Retrieves a paginated list of all files within a specific batch operation. Returns 410 once the vector store has expired. ### Agents #### Agents - [List agents](https://docs.mka1.com/api-reference/agents/list-agents.md) - [Create an agent](https://docs.mka1.com/api-reference/agents/create-an-agent.md) - [Retrieve an agent](https://docs.mka1.com/api-reference/agents/retrieve-an-agent.md) - [Update an agent](https://docs.mka1.com/api-reference/agents/update-an-agent.md) - [Delete an agent](https://docs.mka1.com/api-reference/agents/delete-an-agent.md) #### Agent Versions - [List agent versions](https://docs.mka1.com/api-reference/agent-versions/list-agent-versions.md): Lists the configuration history for an agent. Each committed change (create, update, rollback) appends a version. - [Retrieve an agent version](https://docs.mka1.com/api-reference/agent-versions/retrieve-an-agent-version.md) - [Roll back an agent to a version](https://docs.mka1.com/api-reference/agent-versions/roll-back-an-agent-to-a-version.md): Restores the target version's configuration as a new current version. History is preserved: the restore is appended as a new version rather than deleting later ones. #### Agent Runs - [List runs for an agent](https://docs.mka1.com/api-reference/agent-runs/list-runs-for-an-agent.md) - [Start a saved agent run](https://docs.mka1.com/api-reference/agent-runs/start-a-saved-agent-run.md): Starts an asynchronous background run for a saved agent and returns the queued run record. Use the run retrieval endpoint to poll status or the events endpoint to stream progress. - [Stream agent run events](https://docs.mka1.com/api-reference/agent-runs/stream-agent-run-events.md): Streams Server-Sent Events for the gateway response linked to this agent run. Terminal runs emit a single terminal event and close. - [Wake a sleeping agent run](https://docs.mka1.com/api-reference/agent-runs/wake-a-sleeping-agent-run.md): Interrupts a short sleep tool call on a background run by forwarding follow-up input to the gateway response. - [Approve or deny a pending MCP tool call](https://docs.mka1.com/api-reference/agent-runs/approve-or-deny-a-pending-mcp-tool-call.md): Creates a continuation run for an mcp_approval_request emitted by the source run. The gateway binds the single-use decision to the original server, tool, and arguments; denying never invokes the remote MCP tool. - [Retrieve an agent run](https://docs.mka1.com/api-reference/agent-runs/retrieve-an-agent-run.md) #### Agent Connectors - [List connectors for an agent](https://docs.mka1.com/api-reference/agent-connectors/list-connectors-for-an-agent.md): Lists messaging-channel connectors configured for the agent. Connector credentials are never returned. - [Create a connector](https://docs.mka1.com/api-reference/agent-connectors/create-a-connector.md): Connects the agent to a Telegram bot or WhatsApp Business phone number, validates the provider credentials, and registers the agent's webhook. WhatsApp connector support is beta. Text, photos, and gateway-supported documents can invoke the agent; inbound media additionally requires write:files. Mana… - [Set up a WhatsApp app webhook (Beta)](https://docs.mka1.com/api-reference/agent-connectors/set-up-a-whatsapp-app-webhook-beta.md): Beta. Returns the app-level callback URL and verification token that must be saved in Meta before the first WhatsApp phone connector is created. The caller must be allowed to manage the agent. The stable verification token is returned only in this no-store response and is not a Meta access token. - [Retrieve a connector](https://docs.mka1.com/api-reference/agent-connectors/retrieve-a-connector.md): Retrieves connector configuration and status without exposing credentials. - [Delete a connector](https://docs.mka1.com/api-reference/agent-connectors/delete-a-connector.md): Unregisters the connector-specific provider webhook and deletes the stored connector credentials. Telegram pending updates are dropped; WhatsApp deletion clears only the phone-number callback and does not unsubscribe other numbers in the business account. - [Activate a connector](https://docs.mka1.com/api-reference/agent-connectors/activate-a-connector.md): Revalidates the stored provider credentials and registers the provider webhook. Use this to retry a connector left in an error state. API-key authentication with every listed scope is required; session authentication is rejected, and the key must belong to the connector's original user or service-ac… #### Agent Schedules - [List schedules for an agent](https://docs.mka1.com/api-reference/agent-schedules/list-schedules-for-an-agent.md) - [Create an agent schedule](https://docs.mka1.com/api-reference/agent-schedules/create-an-agent-schedule.md): Creates a Temporal-backed one-time, interval, or cron schedule that starts normal saved agent runs. - [Retrieve an agent schedule](https://docs.mka1.com/api-reference/agent-schedules/retrieve-an-agent-schedule.md) - [Update an agent schedule](https://docs.mka1.com/api-reference/agent-schedules/update-an-agent-schedule.md) - [Delete an agent schedule](https://docs.mka1.com/api-reference/agent-schedules/delete-an-agent-schedule.md) - [Pause an agent schedule](https://docs.mka1.com/api-reference/agent-schedules/pause-an-agent-schedule.md) - [Resume an agent schedule](https://docs.mka1.com/api-reference/agent-schedules/resume-an-agent-schedule.md) #### Memory Stores - [Create memory store](https://docs.mka1.com/api-reference/memory-stores/create-memory-store.md): Creates a memory store for persistent agent notes. Stores are private by default and can be shared across the workspace. - [List memory stores](https://docs.mka1.com/api-reference/memory-stores/list-memory-stores.md) - [Retrieve memory store](https://docs.mka1.com/api-reference/memory-stores/retrieve-memory-store.md) - [Update memory store](https://docs.mka1.com/api-reference/memory-stores/update-memory-store.md) - [Delete memory store](https://docs.mka1.com/api-reference/memory-stores/delete-memory-store.md) - [Create memory entry](https://docs.mka1.com/api-reference/memory-stores/create-memory-entry.md) - [List memory entries](https://docs.mka1.com/api-reference/memory-stores/list-memory-entries.md) - [Retrieve memory entry](https://docs.mka1.com/api-reference/memory-stores/retrieve-memory-entry.md) - [Update memory entry](https://docs.mka1.com/api-reference/memory-stores/update-memory-entry.md) - [Delete memory entry](https://docs.mka1.com/api-reference/memory-stores/delete-memory-entry.md) ### Tools and sandbox #### MCP Vault - [Create MCP server](https://docs.mka1.com/api-reference/mcp-vault/create-mcp-server.md): Creates a user-owned MCP server configuration. Secret credentials are stored separately. - [List MCP servers](https://docs.mka1.com/api-reference/mcp-vault/list-mcp-servers.md): Lists MCP server configurations owned by the authenticated user context. - [Retrieve MCP server](https://docs.mka1.com/api-reference/mcp-vault/retrieve-mcp-server.md): Returns a user-owned MCP server configuration. - [Update MCP server](https://docs.mka1.com/api-reference/mcp-vault/update-mcp-server.md): Partially updates a user-owned MCP server configuration. - [Delete MCP server](https://docs.mka1.com/api-reference/mcp-vault/delete-mcp-server.md): Soft-deletes a user-owned MCP server and revokes its credentials. - [Create MCP credential](https://docs.mka1.com/api-reference/mcp-vault/create-mcp-credential.md): Stores encrypted credentials for a user-owned MCP server. Secret values are never returned. - [List MCP credentials](https://docs.mka1.com/api-reference/mcp-vault/list-mcp-credentials.md): Lists encrypted credential metadata for a user-owned MCP server. - [Delete MCP credential](https://docs.mka1.com/api-reference/mcp-vault/delete-mcp-credential.md): Revokes a user-owned MCP credential. - [Test MCP server](https://docs.mka1.com/api-reference/mcp-vault/test-mcp-server.md): Connects to an MCP server using the authenticated user's stored credential and returns discovered tool names. Failed connections return a 502 error; connection details are retained in redacted server logs. #### Skills - [Create skill](https://docs.mka1.com/api-reference/skills/create-skill.md): Create a new skill by uploading files. The uploaded files must include a SKILL.md manifest. Accepts multipart form data with individual files or a single zip archive. - [List skills](https://docs.mka1.com/api-reference/skills/list-skills.md): Returns a paginated list of skills. - [Retrieve skill](https://docs.mka1.com/api-reference/skills/retrieve-skill.md): Returns information about a specific skill. - [Update skill](https://docs.mka1.com/api-reference/skills/update-skill.md): Update the default version pointer for a skill. - [Delete skill](https://docs.mka1.com/api-reference/skills/delete-skill.md): Delete a skill and all its versions. - [Download skill content](https://docs.mka1.com/api-reference/skills/download-skill-content.md): Download the zip bundle for a skill's default version. - [Create skill version](https://docs.mka1.com/api-reference/skills/create-skill-version.md): Create a new immutable version of a skill by uploading files. The uploaded files must include a SKILL.md manifest. - [List skill versions](https://docs.mka1.com/api-reference/skills/list-skill-versions.md): Returns a paginated list of versions for a skill. - [Retrieve skill version](https://docs.mka1.com/api-reference/skills/retrieve-skill-version.md): Returns information about a specific skill version. - [Delete skill version](https://docs.mka1.com/api-reference/skills/delete-skill-version.md): Delete a specific version of a skill. - [Download skill version content](https://docs.mka1.com/api-reference/skills/download-skill-version-content.md): Download the zip bundle for a specific skill version. - [List preconfigured skills](https://docs.mka1.com/api-reference/skills/list-preconfigured-skills.md): Returns the list of preconfigured skills that ship with the gateway. These can be referenced in shell tool definitions as { type: 'preconfigured', name: '...' }. #### Sessions - [Create Session](https://docs.mka1.com/api-reference/sessions/create-session.md): Create a sandbox session and return its public session metadata, session token, and provider. Set `session_kind` to `browser` to start a browser-backed session instead of a standard command/code sandbox. Set `queue_if_full` to `true` to queue the request instead of failing when runner capacity is te… - [List Sessions](https://docs.mka1.com/api-reference/sessions/list-sessions.md): List sandbox sessions visible to the authenticated caller. - [Get Session](https://docs.mka1.com/api-reference/sessions/get-session.md): Return the current state, configuration, and resource allocation for a sandbox session. - [Terminate Session](https://docs.mka1.com/api-reference/sessions/terminate-session.md): Stop a sandbox session and release the backing sandbox resources. #### Execution - [Run Command](https://docs.mka1.com/api-reference/execution/run-command.md): Run a command in the session workspace and return stdout, stderr, exit code, and changed files. - [Run Code](https://docs.mka1.com/api-reference/execution/run-code.md): Execute source code in the session workspace using a supported runtime and return the execution result. #### Workspace - [Get Workspace Manifest](https://docs.mka1.com/api-reference/workspace/get-workspace-manifest.md): List files currently stored in the session workspace, including paths, sizes, and etags. - [Download Workspace File](https://docs.mka1.com/api-reference/workspace/download-workspace-file.md): Download raw bytes from a file in the session workspace. - [Upload Workspace File](https://docs.mka1.com/api-reference/workspace/upload-workspace-file.md): Upload raw bytes into the session workspace at the given path. - [Download Workspace Archive](https://docs.mka1.com/api-reference/workspace/download-workspace-archive.md): Download a zip archive containing the selected workspace paths. - [Upload Workspace Archive](https://docs.mka1.com/api-reference/workspace/upload-workspace-archive.md): Upload a zip archive and extract its files into the session workspace. #### Sandbox Usage - [Get Sandbox Usage](https://docs.mka1.com/api-reference/sandbox-usage/get-sandbox-usage.md): Aggregate sandbox usage (session lifecycle, execution, and workspace operations) over a time range, bucketed and optionally grouped. Buckets are calendar-aligned in UTC: `start_time` is snapped down and `end_time` snapped up to the nearest bucket-width boundary, so the first and last buckets may ext… #### Sandbox Pricing - [Get Sandbox Pricing](https://docs.mka1.com/api-reference/sandbox-pricing/get-sandbox-pricing.md): Current sandbox pricing rate card, keyed by SKU (`standard`, `browser`, `eval-python`). Metered sandbox usage is billed `hours × (per_hour + reserved_memory_GiB × per_gib_hour)`; SKUs without a configured rate accrue no spend. Cluster admins only. - [Set Sandbox Pricing](https://docs.mka1.com/api-reference/sandbox-pricing/set-sandbox-pricing.md): Replace the sandbox pricing rate card. Full-replace semantics. Omitting a SKU that currently has a price is refused with 422 unless `allow_unpriced` is true: an unpriced SKU accrues no spend and its usage cannot be billed. A `currency` that differs from the stored one is saved only after the budgeti… #### Browser - [Get Browser Session URL](https://docs.mka1.com/api-reference/browser/get-browser-session-url.md): Return the public gateway URL for a browser session's Chrome DevTools Protocol endpoint. Playwright can use this HTTP endpoint directly. For clients that require a WebSocket endpoint, request `json/version` and use its rewritten `webSocketDebuggerUrl`. Insert subpaths before the query string; for ex… - [Get Browser Session URL (Deprecated)](https://docs.mka1.com/api-reference/browser/get-browser-session-url-deprecated.md): Deprecated compatibility alias for `getBrowserUrl`. Return the public gateway URL for a browser session's Chrome DevTools Protocol endpoint. Standard sessions do not expose a public URL; use the command, code, and workspace operations instead. - [Proxy Browser Port Request](https://docs.mka1.com/api-reference/browser/proxy-browser-port-request.md): Proxy an HTTP request to an exposed browser-session port through the gateway. Use the URL returned by `GET /sessions/{session_id}/browser-url` as the base. Insert CDP subpaths such as `json/version` or `json/list` before its query string, preserving the `session_token` parameter. This low-level prox… #### Sandbox GitHub - [Start GitHub Authorization](https://docs.mka1.com/api-reference/sandbox-github/start-github-authorization.md): Start connecting the caller's GitHub account. Send the user to the returned `authorize_url`. GitHub redirects back with a `code` and the same `state`; pass both to `POST /github/oauth/connections` before `expires_in_seconds` elapses. Each `state` works once. - [Connect GitHub Account](https://docs.mka1.com/api-reference/sandbox-github/connect-github-account.md): Finish GitHub authorization by exchanging the `code` and `state` from GitHub's redirect for a stored connection. The sandbox service keeps the access token encrypted and never returns it. The response lists the repositories the connection can reach. - [Get GitHub Connection](https://docs.mka1.com/api-reference/sandbox-github/get-github-connection.md): Return the caller's GitHub connection, or `null` when there is none. `token_invalid_at` is set once GitHub has rejected the stored token; reconnect to fix it. Set `verify` to `true` to check the token with GitHub now instead of at its next use. - [Disconnect GitHub Account](https://docs.mka1.com/api-reference/sandbox-github/disconnect-github-account.md): Delete the caller's GitHub connection and revoke its token at GitHub. The connection is deleted even if GitHub does not confirm the revocation. - [List GitHub Repositories](https://docs.mka1.com/api-reference/sandbox-github/list-github-repositories.md): List the repositories recorded for the caller's GitHub connection, or an empty list when there is no connection. The list is captured when you connect; call `POST /github/repositories/refresh` to update it. - [Refresh GitHub Repositories](https://docs.mka1.com/api-reference/sandbox-github/refresh-github-repositories.md): Re-read the repositories the caller's GitHub connection can reach, save them as the connection's repository list, and return it. - [Resolve GitHub Reference](https://docs.mka1.com/api-reference/sandbox-github/resolve-github-reference.md): Resolve a Git reference in a connected repository to a commit SHA. Omit `ref` to resolve the repository's default branch. - [Clone GitHub Repository into Session](https://docs.mka1.com/api-reference/sandbox-github/clone-github-repository-into-session.md): Clone a connected repository at `base_sha` into the session workspace using the caller's GitHub connection. The sandbox host runs the clone, so the token never enters the session. - [List Session Repositories](https://docs.mka1.com/api-reference/sandbox-github/list-session-repositories.md): Return the repositories added to the session with each one's ref, checkout path, clone status, last push, and pull request, plus the per-session repository limit. - [Add Session Repository](https://docs.mka1.com/api-reference/sandbox-github/add-session-repository.md): Add a connected repository to the session and clone it at `ref`, or at the default branch when `ref` is omitted. Repeating the same request is safe. After a successful clone the repository's ref cannot change. - [Dismiss Failed Session Repository](https://docs.mka1.com/api-reference/sandbox-github/dismiss-failed-session-repository.md): Remove a repository whose clone failed from the session. A repository that cloned successfully, or whose clone is still in progress, cannot be removed. - [Push Session to GitHub](https://docs.mka1.com/api-reference/sandbox-github/push-session-to-github.md): Push the session's checkout to `branch` in the repository it was cloned from, using the caller's GitHub connection. The repository always comes from the session, never from the request. Set `checkout_path` when the repository is not at the workspace root. - [Create or Update Pull Request](https://docs.mka1.com/api-reference/sandbox-github/create-or-update-pull-request.md): Open a pull request from `branch` in the session's repository, or update the one already recorded for that branch, reopening it if it was closed. The base defaults to the repository's default branch. A merged pull request is never reopened; a later call for the same branch opens a new one. The sessi… #### Sandbox Environments - [List Environments](https://docs.mka1.com/api-reference/sandbox-environments/list-environments.md): List the caller's saved environments, plus the per-environment repository limit. - [Create Environment](https://docs.mka1.com/api-reference/sandbox-environments/create-environment.md): Save a named environment: repositories to clone, environment variables, network access, and an optional bash setup script. Sessions created from it copy these settings. Do not put secrets in `environment_variables`. - [Get Environment](https://docs.mka1.com/api-reference/sandbox-environments/get-environment.md): Return one of the caller's saved environments. - [Update Environment](https://docs.mka1.com/api-reference/sandbox-environments/update-environment.md): Replace a saved environment's settings. Omit `network_access` to keep the stored value. Sessions already created from the environment keep the settings they started with. - [Delete Environment](https://docs.mka1.com/api-reference/sandbox-environments/delete-environment.md): Delete a saved environment. Sessions already created from it are not affected. - [Run Environment Setup](https://docs.mka1.com/api-reference/sandbox-environments/run-environment-setup.md): Run the setup script of the environment the session was created from. Call it once the session's repositories have cloned. A `running` status means setup has not finished yet and calling again is safe; once setup has succeeded, later calls return `succeeded` without running it again. ### Evals and feedback #### Evals - [Create an eval suite](https://docs.mka1.com/api-reference/evals/create-an-eval-suite.md): Creates a team-scoped declarative eval suite. Dataset and Python grader files must be uploaded separately with purpose 'evals'. - [List eval suites](https://docs.mka1.com/api-reference/evals/list-eval-suites.md): Returns eval suites visible to the authenticated team context. - [Get an eval suite](https://docs.mka1.com/api-reference/evals/get-an-eval-suite.md): Retrieves an eval suite by ID. - [Delete an eval suite](https://docs.mka1.com/api-reference/evals/delete-an-eval-suite.md): Soft-deletes an eval suite and all of its eval runs so they no longer appear in user-facing reads. - [Create an eval suite version](https://docs.mka1.com/api-reference/evals/create-an-eval-suite-version.md): Creates an immutable suite version. Use this endpoint for edits to an existing eval suite. - [List eval suite versions](https://docs.mka1.com/api-reference/evals/list-eval-suite-versions.md): Returns immutable versions for an eval suite, including each version manifest. - [Get an eval suite version](https://docs.mka1.com/api-reference/evals/get-an-eval-suite-version.md): Retrieves an immutable eval suite version and its manifest. - [List leaderboard runs for an eval suite](https://docs.mka1.com/api-reference/evals/list-leaderboard-runs-for-an-eval-suite.md): Returns each ranking group's most recent completed runs for a suite in one request, with the group assignments in `groups`. A group is (model, targeted task) for task_ids-restricted runs and (model) for unrestricted runs (task_id null). Build boards from `groups`, not from run.models/run.task_ids —… - [Get the coding-agent leaderboard for an eval suite](https://docs.mka1.com/api-reference/evals/get-the-coding-agent-leaderboard-for-an-eval-suite.md): Ranks the suite's completed coding-agent runs, one row per (agent, model, effort). Only runs that recorded an `agent_name` participate — a QA or transcription run of the same suite has no agent to attribute a score to and is not a board row. `accuracy` is the mean of `metric` (default `reward`) over… - [Count tokens from stored text for a suite's unmeasured samples](https://docs.mka1.com/api-reference/evals/count-tokens-from-stored-text-for-a-suites-unmeasured-samples.md): Backfill for rows written before the gateway recorded usage. For samples of the suite's completed runs that have answer or reasoning text but no token figure, counts prompt, reasoning and answer tokens from the stored text (tiktoken o200k_base, one ruler for every model), marks them `tokens_estimate… - [Create an eval run](https://docs.mka1.com/api-reference/evals/create-an-eval-run.md): Starts a durable eval run over the selected suite version, tasks, and models. - [List eval runs](https://docs.mka1.com/api-reference/evals/list-eval-runs.md): Returns eval runs visible to the authenticated team context. suite_version is a per-suite ordinal and must be paired with suite_id; supplying it alone returns 400. - [Get an eval run](https://docs.mka1.com/api-reference/evals/get-an-eval-run.md): Retrieves an eval run by ID. - [Delete an eval run](https://docs.mka1.com/api-reference/evals/delete-an-eval-run.md): Soft-deletes an eval run so it no longer appears in run lists, details, or score leaderboards. - [Cancel an eval run](https://docs.mka1.com/api-reference/evals/cancel-an-eval-run.md): Requests cancellation for a queued or running eval run. - [Rerun failed eval samples](https://docs.mka1.com/api-reference/evals/rerun-failed-eval-samples.md): Queues a completed eval run to retry only samples with sample status 'failed'. Retried samples keep the same run ID and sample IDs, replacing errored sample results in place. - [Retry an eval run](https://docs.mka1.com/api-reference/evals/retry-an-eval-run.md): Queues a failed or cancelled eval run to retry in place. Completed samples keep their results, generated-but-unscored cancelled samples resume at scoring, unfinished samples are requeued, and runs with no persisted samples are prepared from scratch with the same run ID. - [Get an eval run overview](https://docs.mka1.com/api-reference/evals/get-an-eval-run-overview.md): Aggregate header for one run's trials view: trial counts, average reward, cost, and the input/output/cached token split. Its own route rather than fields on the run object because it scans the run's samples — folding it into `GET /evals/runs/{run_id}` would charge that scan to every run list and to… - [List eval samples](https://docs.mka1.com/api-reference/evals/list-eval-samples.md): Returns prompt, target, model output, extraction, score, and judge details for an eval run. - [Get eval sample audio](https://docs.mka1.com/api-reference/evals/get-eval-sample-audio.md): Returns `{ object, audio, sample_index, task_id, model }` for a single transcription sample — the clip reference (a base64 `data:` URI or a URL) read from the un-redacted `dataset_row` (list responses redact inline `data:` blobs), plus the resolved task/model. Prefers the task's configured `audio_co… - [Get an eval sample trajectory](https://docs.mka1.com/api-reference/evals/get-an-eval-sample-trajectory.md): Returns one coding-agent trial's session — the steps the agent took, verbatim in the harness's interchange format (see `schema_version`, e.g. `ATIF-v1.7`). Deliberately not part of the samples list: a trajectory averages ~92 KB and that list pages up to 500 rows. Sample indices are unique per (task,… - [Upload an eval sample trajectory](https://docs.mka1.com/api-reference/evals/upload-an-eval-sample-trajectory.md): Stores one coding-agent trial's session, in whatever interchange format the harness produced (record it in `schema_version`, e.g. `ATIF-v1.7`). `steps` is stored verbatim and never validated, so a harness format change needs no gateway release. Separate from the run import because a trajectory avera… - [Get eval run artifacts](https://docs.mka1.com/api-reference/evals/get-eval-run-artifacts.md): Returns generated result and sample artifact file IDs for a completed eval run. - [Import a finished coding-agent run](https://docs.mka1.com/api-reference/evals/import-a-finished-coding-agent-run.md): Uploads one completed harness job — the run and its trials — directly, so results never round-trip through external storage the way the Hugging Face importer does. Every `task_id` must already exist in the target suite version's manifest; unknown ids are rejected rather than invented, because a typo… - [Append trials to an open coding-agent run](https://docs.mka1.com/api-reference/evals/append-trials-to-an-open-coding-agent-run.md): Adds finished trials to a run opened with `finalize: false`, so a job started from MKA1 can be watched while it runs instead of appearing complete out of nowhere at the end. Each trial pins its own `sample_index` and upserts on (task, model, sample_index): a harness cannot tell a timeout from a lost… - [Import historical eval results from Hugging Face](https://docs.mka1.com/api-reference/evals/import-historical-eval-results-from-hugging-face.md): Imports simplified historical samples.jsonl-style eval results from a Hugging Face dataset repository into a completed eval suite run shape. Aggregates are recomputed from samples and include canonical score metrics for leaderboards. - [Create an eval schedule](https://docs.mka1.com/api-reference/evals/create-an-eval-schedule.md): Schedules an eval run to fire on a cron or interval cadence, with optional webhook notifications of run status. - [List eval schedules](https://docs.mka1.com/api-reference/evals/list-eval-schedules.md): Returns eval schedules visible to the authenticated team context. - [Get an eval schedule](https://docs.mka1.com/api-reference/evals/get-an-eval-schedule.md): Retrieves an eval schedule by ID, including the next scheduled fire time from Temporal when resolvable. - [Update an eval schedule](https://docs.mka1.com/api-reference/evals/update-an-eval-schedule.md): Updates an eval schedule's cadence, run config, webhook, overlap policy, or enabled state. - [Delete an eval schedule](https://docs.mka1.com/api-reference/evals/delete-an-eval-schedule.md): Soft-deletes an eval schedule and removes its Temporal schedule. Historical runs are preserved. - [Trigger an eval schedule now](https://docs.mka1.com/api-reference/evals/trigger-an-eval-schedule-now.md): Fires the schedule immediately, in addition to its normal cadence. - [List runs created by an eval schedule](https://docs.mka1.com/api-reference/evals/list-runs-created-by-an-eval-schedule.md): Returns eval runs that were created by the given schedule. suite_version may be used without suite_id here, since the schedule already pins the suite; supplying a suite_id that is not the schedule's returns 400. #### Feedback - [Submit feedback for chat completion](https://docs.mka1.com/api-reference/feedback/submit-feedback-for-chat-completion.md): Submit user feedback for a specific chat completion to track satisfaction and model performance. Each completion can only receive feedback once. - [List chat completion feedback](https://docs.mka1.com/api-reference/feedback/list-chat-completion-feedback.md): Retrieves a paginated list of feedback entries recorded on the caller's chat completions, ordered by the completion's creation date. Supports filtering by rating. An `after` cursor that no longer resolves to a completion visible to the caller returns 400; restart pagination from the first page. - [Retrieve feedback by completion ID](https://docs.mka1.com/api-reference/feedback/retrieve-feedback-by-completion-id.md): Retrieves the existing feedback rating and description for a specific chat completion. - [Update existing completion feedback](https://docs.mka1.com/api-reference/feedback/update-existing-completion-feedback.md): Updates or modifies existing feedback for a specific chat completion. Useful for allowing users to revise their initial submissions. - [Batch retrieve feedback for multiple completions](https://docs.mka1.com/api-reference/feedback/batch-retrieve-feedback-for-multiple-completions.md): Retrieves feedback for multiple chat completions in a single batch request. - [Submit feedback for response](https://docs.mka1.com/api-reference/feedback/submit-feedback-for-response.md): Submit user feedback for a specific agent response to track satisfaction and model performance. Each response can only receive feedback once. - [List response feedback](https://docs.mka1.com/api-reference/feedback/list-response-feedback.md): Retrieves a paginated list of feedback entries recorded on the caller's agent responses, ordered by the response's creation date. Supports filtering by rating. An `after` cursor that no longer resolves to a response visible to the caller — including responses that have since been deleted — returns 4… - [Retrieve feedback by response ID](https://docs.mka1.com/api-reference/feedback/retrieve-feedback-by-response-id.md): Retrieves the existing feedback rating and description for a specific agent response. - [Update existing response feedback](https://docs.mka1.com/api-reference/feedback/update-existing-response-feedback.md): Updates or modifies existing feedback for a specific agent response. Useful for allowing users to revise their initial submissions. - [Batch retrieve feedback for multiple responses](https://docs.mka1.com/api-reference/feedback/batch-retrieve-feedback-for-multiple-responses.md): Retrieves feedback for multiple agent responses in a single batch request. - [Export completion feedback as CSV](https://docs.mka1.com/api-reference/feedback/export-completion-feedback-as-csv.md): Synchronously exports the completion feedback entries visible to the caller as a CSV file, ordered by the creation date of the underlying request. Visibility matches the list endpoint: callers see their own feedback; org owners and admins see their whole team. Supports filtering by rating. The expor… - [Export response feedback as CSV](https://docs.mka1.com/api-reference/feedback/export-response-feedback-as-csv.md): Synchronously exports the response feedback entries visible to the caller as a CSV file, ordered by the creation date of the underlying request. Visibility matches the list endpoint: callers see their own feedback; org owners and admins see their whole team. Supports filtering by rating. The export… - [Start feedback export](https://docs.mka1.com/api-reference/feedback/start-feedback-export.md): Starts a background job to export all feedback data across every tenant to parquet files in S3/R2. Only one export can run simultaneously. Restricted to cluster administrators. - [Get feedback export status](https://docs.mka1.com/api-reference/feedback/get-feedback-export-status.md): Checks the status and progress of the currently running or most recently completed feedback export job. Restricted to cluster administrators. ### Compute #### Compute Jobs - [List jobs](https://docs.mka1.com/api-reference/compute-jobs/list-jobs.md) - [Create a job](https://docs.mka1.com/api-reference/compute-jobs/create-a-job.md) - [Get a job](https://docs.mka1.com/api-reference/compute-jobs/get-a-job.md) - [List job events](https://docs.mka1.com/api-reference/compute-jobs/list-job-events.md) - [List observed job instances](https://docs.mka1.com/api-reference/compute-jobs/list-observed-job-instances.md) - [List job logs](https://docs.mka1.com/api-reference/compute-jobs/list-job-logs.md) - [Terminate a job](https://docs.mka1.com/api-reference/compute-jobs/terminate-a-job.md) #### Compute Services - [List services](https://docs.mka1.com/api-reference/compute-services/list-services.md) - [Create a service](https://docs.mka1.com/api-reference/compute-services/create-a-service.md) - [Get a service](https://docs.mka1.com/api-reference/compute-services/get-a-service.md) - [List service events](https://docs.mka1.com/api-reference/compute-services/list-service-events.md) - [List observed service instances](https://docs.mka1.com/api-reference/compute-services/list-observed-service-instances.md) - [List service logs](https://docs.mka1.com/api-reference/compute-services/list-service-logs.md) - [Replace a service scaling policy](https://docs.mka1.com/api-reference/compute-services/replace-a-service-scaling-policy.md) - [Terminate a service](https://docs.mka1.com/api-reference/compute-services/terminate-a-service.md) #### Compute Catalog - [List accelerators](https://docs.mka1.com/api-reference/compute-catalog/list-accelerators.md) - [Get an accelerator](https://docs.mka1.com/api-reference/compute-catalog/get-an-accelerator.md) - [List provider offers](https://docs.mka1.com/api-reference/compute-catalog/list-provider-offers.md): Cluster administrators may always read this route. Organization administrators may read it only when provider anonymity is disabled. - [List provider health](https://docs.mka1.com/api-reference/compute-catalog/list-provider-health.md): Cluster administrators may always read this route. Organization administrators may read it only when provider anonymity is disabled. - [Create a quote](https://docs.mka1.com/api-reference/compute-catalog/create-a-quote.md) #### Compute Secrets - [List secrets](https://docs.mka1.com/api-reference/compute-secrets/list-secrets.md) - [Create a secret](https://docs.mka1.com/api-reference/compute-secrets/create-a-secret.md) - [Delete a secret](https://docs.mka1.com/api-reference/compute-secrets/delete-a-secret.md) - [Get a secret](https://docs.mka1.com/api-reference/compute-secrets/get-a-secret.md) #### Compute Volumes - [List organization volumes](https://docs.mka1.com/api-reference/compute-volumes/list-organization-volumes.md) - [Create a standalone shared volume](https://docs.mka1.com/api-reference/compute-volumes/create-a-standalone-shared-volume.md) - [Permanently delete a standalone volume](https://docs.mka1.com/api-reference/compute-volumes/permanently-delete-a-standalone-volume.md): Deletion bypasses tenant enablement and budget gates, but is refused while non-terminal attachments exist. - [Get a standalone volume](https://docs.mka1.com/api-reference/compute-volumes/get-a-standalone-volume.md) - [List volume attachments](https://docs.mka1.com/api-reference/compute-volumes/list-volume-attachments.md) #### Compute Usage - [Get usage](https://docs.mka1.com/api-reference/compute-usage/get-usage.md) #### Compute Tenants - [List tenants](https://docs.mka1.com/api-reference/compute-tenants/list-tenants.md): Cluster-administrator-only. - [Get a tenant](https://docs.mka1.com/api-reference/compute-tenants/get-a-tenant.md): Cluster-administrator-only. - [Update a tenant](https://docs.mka1.com/api-reference/compute-tenants/update-a-tenant.md): Cluster-administrator-only idempotent upsert. #### Compute Pricing - [Get the latest committed storage price](https://docs.mka1.com/api-reference/compute-pricing/get-the-latest-committed-storage-price.md): The latest version may be scheduled for the next UTC hour. Before the first version is written this route returns pricing_not_configured. - [Create an immutable storage-price version](https://docs.mka1.com/api-reference/compute-pricing/create-an-immutable-storage-price-version.md): Cluster administrators only. If-Match: 0 performs the explicit bootstrap. Every version activates at the next UTC-hour boundary; equivalent idempotent replay precedes version comparison. #### Tracking Experiments - [Create](https://docs.mka1.com/api-reference/tracking-experiments/create.md): Create a namespaced experiment. Artifact locations are managed by the service. Requires `write:tracking`. Results are restricted to the API key organization and team. - [Search](https://docs.mka1.com/api-reference/tracking-experiments/search.md): Requires `read:tracking`. Results are restricted to the API key organization and team. - [Get](https://docs.mka1.com/api-reference/tracking-experiments/get.md): Requires `read:tracking`. Results are restricted to the API key organization and team. - [GetByName](https://docs.mka1.com/api-reference/tracking-experiments/getbyname.md): Requires `read:tracking`. Results are restricted to the API key organization and team. - [Delete](https://docs.mka1.com/api-reference/tracking-experiments/delete.md): Requires `write:tracking`. Results are restricted to the API key organization and team. #### Tracking Runs - [Create](https://docs.mka1.com/api-reference/tracking-runs/create.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [Get](https://docs.mka1.com/api-reference/tracking-runs/get.md): Requires `read:tracking`. Results are restricted to the API key organization and team. - [Search](https://docs.mka1.com/api-reference/tracking-runs/search.md): Explicit experiment IDs are required; every experiment must belong to the caller. Requires `read:tracking`. Results are restricted to the API key organization and team. - [Update](https://docs.mka1.com/api-reference/tracking-runs/update.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [Delete](https://docs.mka1.com/api-reference/tracking-runs/delete.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [Restore](https://docs.mka1.com/api-reference/tracking-runs/restore.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [LogMetric](https://docs.mka1.com/api-reference/tracking-runs/logmetric.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [LogParameter](https://docs.mka1.com/api-reference/tracking-runs/logparameter.md): Requiere `write:tracking`. Los resultados están restringidos a la organización y al equipo de la clave de API. - [SetTag](https://docs.mka1.com/api-reference/tracking-runs/settag.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [DeleteTag](https://docs.mka1.com/api-reference/tracking-runs/deletetag.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [LogBatch](https://docs.mka1.com/api-reference/tracking-runs/logbatch.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [LogInputs](https://docs.mka1.com/api-reference/tracking-runs/loginputs.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [GetMetricHistory](https://docs.mka1.com/api-reference/tracking-runs/getmetrichistory.md): Requires `read:tracking`. Results are restricted to the API key organization and team. ### Repositories #### Repositories - [List the caller's org's repositories](https://docs.mka1.com/api-reference/repositories/list-the-callers-orgs-repositories.md): Returns every repository in the caller's org (org owner/admin only). Read-only. With `kind`, only repositories of that kind; an untyped (legacy, `kind: null`) repository appears in the unfiltered listing only. - [Create a repository](https://docs.mka1.com/api-reference/repositories/create-a-repository.md): Provisions a repository (org owner/admin only); a failed provision is rolled back best-effort (see the `502`). The repository belongs to the caller's org. `kind` says what it will hold and defaults to `repo` (a plain git repository); it decides which protocol planes answer for the name (see the `Rep… - [Delete a repository](https://docs.mka1.com/api-reference/repositories/delete-a-repository.md): Removes a repository; org owner/admin only. The deletion is authoritative; the contents are cleaned up best-effort. - [Get a repository](https://docs.mka1.com/api-reference/repositories/get-a-repository.md): Reads a single repository after the org+role access check (org owner/admin of the repository's org only). - [Update a repository's labels](https://docs.mka1.com/api-reference/repositories/update-a-repositorys-labels.md): Applies a label-only update (name/description/kind); org owner/admin only. The repository id is stable, so a rename touches no contents. Omitted fields are left unchanged. #### Image tags - [List an image repository's tags](https://docs.mka1.com/api-reference/repositories/list-an-image-repositorys-tags.md): Lists the container-image tags a repository holds, newest-moved first, each with the manifest it points at, the manifest's media type, the image's declared size and when the tag last moved. The same access check as reading the repository (org owner/admin; `read:repos` for a key). - [Delete an image tag](https://docs.mka1.com/api-reference/repositories/delete-an-image-tag.md): Removes one tag; org owner/admin only (`write:repos` for a key). The same untag as the registry's `DELETE /v2/{org}/{name}/manifests/{tag}`: the name goes and the image stays, reachable by digest and by any other tag that names it. ### Dataset generations #### Generations - [List Generations](https://docs.mka1.com/api-reference/generations/list-generations.md) - [Create Generation](https://docs.mka1.com/api-reference/generations/create-generation.md): The components.md §6 D.1 sequence, in its order: the run credential is minted before anything is spent, nothing is written before the digest is pinned, and the workflow starts only after the row is committed. - [Get Generation](https://docs.mka1.com/api-reference/generations/get-generation.md) - [Get Logs](https://docs.mka1.com/api-reference/generations/get-logs.md) - [Get Events](https://docs.mka1.com/api-reference/generations/get-events.md) - [Cancel Generation](https://docs.mka1.com/api-reference/generations/cancel-generation.md): api.md §3: `cancelling` is written here, then the signal; a `cancelling` row whose signal was lost (the retry case) is signalled again. #### Generators - [List Generators](https://docs.mka1.com/api-reference/generators/list-generators.md) - [Get Generator](https://docs.mka1.com/api-reference/generators/get-generator.md) - [Quote Generator](https://docs.mka1.com/api-reference/generators/quote-generator.md) #### Formats - [List Formats](https://docs.mka1.com/api-reference/formats/list-formats.md) - [Get Format](https://docs.mka1.com/api-reference/formats/get-format.md) ### Organizations and access #### Organization - [Create a team](https://docs.mka1.com/api-reference/organization/create-a-team.md) - [List teams in an org](https://docs.mka1.com/api-reference/organization/list-teams-in-an-org.md) - [Get a team](https://docs.mka1.com/api-reference/organization/get-a-team.md) - [Rename a team](https://docs.mka1.com/api-reference/organization/rename-a-team.md) - [Delete a team](https://docs.mka1.com/api-reference/organization/delete-a-team.md) - [Add a team member](https://docs.mka1.com/api-reference/organization/add-a-team-member.md): Attach a principal (user or service account) to the team by its userId. - [List team members](https://docs.mka1.com/api-reference/organization/list-team-members.md) - [Remove a team member](https://docs.mka1.com/api-reference/organization/remove-a-team-member.md) - [Create a service account](https://docs.mka1.com/api-reference/organization/create-a-service-account.md): Mint a non-human principal scoped to this org (org owner/admin only). - [List service accounts](https://docs.mka1.com/api-reference/organization/list-service-accounts.md) - [Get a service account](https://docs.mka1.com/api-reference/organization/get-a-service-account.md) - [Delete a service account](https://docs.mka1.com/api-reference/organization/delete-a-service-account.md) - [List a service account's API keys](https://docs.mka1.com/api-reference/organization/list-a-service-accounts-api-keys.md) - [Update a service-account API key](https://docs.mka1.com/api-reference/organization/update-a-service-account-api-key.md) - [Delete a service-account API key](https://docs.mka1.com/api-reference/organization/delete-a-service-account-api-key.md) - [Rotate a service-account API key's secret](https://docs.mka1.com/api-reference/organization/rotate-a-service-account-api-keys-secret.md) - [Get basic organization details](https://docs.mka1.com/api-reference/organization/get-basic-organization-details.md): Returns basic fields and the full metadata object to a member of the organization or a cluster admin. It never includes member identities, invitations, or API-key details. - [Patch organization metadata (cluster-admin)](https://docs.mka1.com/api-reference/organization/patch-organization-metadata-cluster-admin.md): Merges supplied top-level metadata keys while preserving omitted siblings. metadata.codeConfig accepts one releaseManifestUrl; codeConfig:null removes that override. - [Get an org's usage quota](https://docs.mka1.com/api-reference/organization/get-an-orgs-usage-quota.md) - [Set an org's usage quota (cluster-admin)](https://docs.mka1.com/api-reference/organization/set-an-orgs-usage-quota-cluster-admin.md) - [Get an org's rate limit](https://docs.mka1.com/api-reference/organization/get-an-orgs-rate-limit.md) - [Set an org's rate limit (cluster-admin)](https://docs.mka1.com/api-reference/organization/set-an-orgs-rate-limit-cluster-admin.md) #### Cluster Admin - [Create a cluster invitation](https://docs.mka1.com/api-reference/cluster-admin/create-a-cluster-invitation.md): Issue a one-shot invite that provisions a new org on acceptance. Email-bound invites can be accepted headless (passwordless + issueApiKey). - [List cluster invitations](https://docs.mka1.com/api-reference/cluster-admin/list-cluster-invitations.md) - [Update a pending cluster invitation](https://docs.mka1.com/api-reference/cluster-admin/update-a-pending-cluster-invitation.md): Extend the expiry or atomically replace the available-model, API-quota, or compute policy of an unclaimed, unexpired invitation. Omitted top-level fields are preserved. - [Revoke a cluster invitation](https://docs.mka1.com/api-reference/cluster-admin/revoke-a-cluster-invitation.md) - [List all organizations](https://docs.mka1.com/api-reference/cluster-admin/list-all-organizations.md) - [Get an organization](https://docs.mka1.com/api-reference/cluster-admin/get-an-organization.md) - [Soft-delete an organization](https://docs.mka1.com/api-reference/cluster-admin/soft-delete-an-organization.md) - [Invite members on behalf of an organization](https://docs.mka1.com/api-reference/cluster-admin/invite-members-on-behalf-of-an-organization.md): Requires a cluster-admin session with Cluster as its active organization. The target must be active and cannot be Cluster. Sends up to 20 organization invitations without switching the admin's session or joining the target organization. Each row accepts role member or admin, defaulting to member; ow… - [Suspend an organization](https://docs.mka1.com/api-reference/cluster-admin/suspend-an-organization.md) - [Unsuspend an organization](https://docs.mka1.com/api-reference/cluster-admin/unsuspend-an-organization.md) - [Re-issue an org owner key (recovery)](https://docs.mka1.com/api-reference/cluster-admin/re-issue-an-org-owner-key-recovery.md): Mint a fresh owner-bound key for an org whose credential was lost. Cluster-admin only (`write:cluster`). Defaults to the org's oldest human owner and oldest team; `userId` / `teamId` override. - [Read cluster-invite info (public)](https://docs.mka1.com/api-reference/cluster-admin/read-cluster-invite-info-public.md) - [Accept a cluster invitation (public)](https://docs.mka1.com/api-reference/cluster-admin/accept-a-cluster-invitation-public.md): Accept an invite and create the org. Existing signed-in user, new email/password owner, or (email-bound) headless machine owner with `passwordless: true, issueApiKey: true`. A reserved slug (`api`, whether supplied as `orgSlug` or derived from `orgName`) is refused with 400 `reserved_org_slug`; a sl… #### Resource Authorization - [Create a new resource](https://docs.mka1.com/api-reference/resource-authorization/create-a-new-resource.md): Create an LLM resource and assign the authenticated caller as owner. Existing owners may pass overwrite=true to replace direct relationships for the resource. - [Delete a resource](https://docs.mka1.com/api-reference/resource-authorization/delete-a-resource.md): Delete an LLM resource and all of its direct permissions. Only owners can delete resources. - [Grant permission to a user or make public](https://docs.mka1.com/api-reference/resource-authorization/grant-permission-to-a-user-or-make-public.md): Grant a role to a user for a git resource, or grant public access by using "*" as userId. Only owners can grant permissions. Public access is allowed only for writer and reader roles. - [Revoke permission from a user or remove public access](https://docs.mka1.com/api-reference/resource-authorization/revoke-permission-from-a-user-or-remove-public-access.md): Revoke a role from a user for a git resource, or remove public access by using "*" as userId. Only owners can revoke permissions. - [List resources the user has access to](https://docs.mka1.com/api-reference/resource-authorization/list-resources-the-user-has-access-to.md): List resources of a specific type where the authenticated caller has the specified role. Returns direct relationships only (not computed). - [List users with permissions](https://docs.mka1.com/api-reference/resource-authorization/list-users-with-permissions.md): List users with a specific role on a resource. Returns direct relationships only (not computed). The authenticated caller must have at least reader access. - [Check user permission](https://docs.mka1.com/api-reference/resource-authorization/check-user-permission.md): Check whether the authenticated caller has a specific role on a resource. - [Create a new git resource](https://docs.mka1.com/api-reference/resource-authorization/create-a-new-git-resource.md): Create a git resource and assign the authenticated caller as owner. Existing owners may pass overwrite=true to replace direct relationships for the resource. - [Delete a git resource](https://docs.mka1.com/api-reference/resource-authorization/delete-a-git-resource.md): Delete a git resource and all of its direct permissions. Only owners can delete resources. - [Grant permission to a user or make public](https://docs.mka1.com/api-reference/resource-authorization/grant-permission-to-a-user-or-make-public.md): Grant a role to a user for a git resource, or grant public access by using "*" as userId. Only owners can grant permissions. Public access is allowed only for writer and reader roles. - [Revoke permission from a user or remove public access](https://docs.mka1.com/api-reference/resource-authorization/revoke-permission-from-a-user-or-remove-public-access.md): Revoke a role from a user for a git resource, or remove public access by using "*" as userId. Only owners can revoke permissions. - [Check an explicit subject permission](https://docs.mka1.com/api-reference/resource-authorization/check-an-explicit-subject-permission.md): Check whether a specific subject (given in the body) has a role on a git resource. Used by the authorization proxy to enforce access for the git user it is acting on behalf of. The authenticated caller must carry the read authorization scope; the subject is independent of the caller. #### API Key - [Mint a scoped API key](https://docs.mka1.com/api-reference/api-key/mint-a-scoped-api-key.md): Mint an API key bound to a (principal, team) carrying an explicit scope set. Requires a session, or a bearer key holding `write:apikeys`. The plaintext secret is returned once. - [List scoped API keys](https://docs.mka1.com/api-reference/api-key/list-scoped-api-keys.md): List the caller's scoped API keys (metadata only — never the secret). Optional `?orgId=&teamId=` narrows; a key caller is scoped to its own org. - [Update a scoped API key](https://docs.mka1.com/api-reference/api-key/update-a-scoped-api-key.md): Update a key's scopes (and optionally name / rate limit). Scopes already on the key are retained; newly-added scopes are bounded by the caller's role (and, for a key caller, the calling key's own scopes). - [Rotate a scoped API key's secret](https://docs.mka1.com/api-reference/api-key/rotate-a-scoped-api-keys-secret.md): Issue a new plaintext secret for an existing key in place (id / scopes / binding preserved). Returned once. - [Exchange API key for a JWT token](https://docs.mka1.com/api-reference/api-key/exchange-api-key-for-a-jwt-token.md): Exchange an API key for a JWT token - [Exchange API key for a JWT token](https://docs.mka1.com/api-reference/api-key/exchange-api-key-for-a-jwt-token.md): Exchange an API key for a JWT token #### Session - [Find an unfinished invitation for the signed-in recipient](https://docs.mka1.com/api-reference/session/find-an-unfinished-invitation-for-the-signed-in-recipient.md): Requires a session with a verified email. Returns a pending, unexpired organization invitation first, otherwise an unclaimed, unexpired cluster invitation bound to that email. Open cluster invitations are never returned. Does not accept or modify the invitation. - [Exchange a live session for a delegated access token](https://docs.mka1.com/api-reference/session/exchange-a-live-session-for-a-delegated-access-token.md): Mints a short-lived, audience-bound token with the same authority as the current live browser or device-login session. Identity, tenancy, permissions, and lifetime cannot be selected by the caller. The JSON body is limited to 4 KiB. ### Application utilities #### Batches - [Create a batch](https://docs.mka1.com/api-reference/batches/create-a-batch.md): Creates and executes a batch from an uploaded JSONL file of requests. Each line must have custom_id, method, url, and body fields. Text batches also require write:responses. - [List batches](https://docs.mka1.com/api-reference/batches/list-batches.md): Returns a paginated list of batches owned by the authenticated user. - [Get a batch](https://docs.mka1.com/api-reference/batches/get-a-batch.md): Retrieves a batch by its ID. - [Cancel a batch](https://docs.mka1.com/api-reference/batches/cancel-a-batch.md): Cancels an in-progress batch. The batch status changes to cancelling, and remaining requests will not be processed. #### Extract - [Extract structured data with inline JSON Schema](https://docs.mka1.com/api-reference/extract/extract-structured-data-with-inline-json-schema.md): Extracts structured data from files using a custom inline JSON schema. - [Create reusable extraction schema template](https://docs.mka1.com/api-reference/extract/create-reusable-extraction-schema-template.md): Creates and stores a reusable JSON Schema template for structured data extraction. - [Get extraction schema by ID](https://docs.mka1.com/api-reference/extract/get-extraction-schema-by-id.md): Retrieve a stored extraction schema and its metadata. - [Update extraction schema by ID](https://docs.mka1.com/api-reference/extract/update-extraction-schema-by-id.md): Update an existing extraction schema and its metadata. - [Delete extraction schema by ID](https://docs.mka1.com/api-reference/extract/delete-extraction-schema-by-id.md): Remove a stored extraction schema. - [Extract data using saved schema template](https://docs.mka1.com/api-reference/extract/extract-data-using-saved-schema-template.md): Extracts structured data from files using a previously saved extraction schema template. #### Guardrails - [Get effective guardrails](https://docs.mka1.com/api-reference/guardrails/get-effective-guardrails.md): Retrieve the guardrails that apply to the caller's requests: the org-wide policy plus the caller's team policy, combined. Both are enforced when both exist. Policies are managed by org admins via PUT /guardrails. - [Update guardrails policy](https://docs.mka1.com/api-reference/guardrails/update-guardrails-policy.md): Replace a guardrails policy. Classifier models must be active and declare structured-output support; replace the example model ID with a suitable model from your organization. Omit team_id to set the org-wide policy (org admin only); provide team_id to set that team's additional policy (org admins m… - [Delete guardrails policy](https://docs.mka1.com/api-reference/guardrails/delete-guardrails-policy.md): Delete a guardrails policy. Omit team_id to delete the org-wide policy (org admin only); provide team_id to delete that team's policy (org admins may target any team in their org, other callers only their own team). Idempotent: deleting a policy that doesn't exist returns deleted: false. - [List guardrails policies](https://docs.mka1.com/api-reference/guardrails/list-guardrails-policies.md): List the stored guardrails policies visible to the caller: org admins see every policy in their org (the org-wide policy has team_id null, plus each team's additional policy); other callers see the org-wide policy and their own team's policy. Unlike GET /guardrails, rows are returned per scope so a… - [Test content against guardrails](https://docs.mka1.com/api-reference/guardrails/test-content-against-guardrails.md): Test a piece of content against the caller's effective guardrails (org-wide policy plus team policy) without generating an answer. Classifier guardrails call their configured model and incur inference usage; API keys additionally require write:responses and must pass the spend budget gate. Useful fo… #### Prompts - [Create a prompt](https://docs.mka1.com/api-reference/prompts/create-a-prompt.md): Creates a new prompt with its first version. The template supports {{variable}} placeholders. - [List prompts](https://docs.mka1.com/api-reference/prompts/list-prompts.md): Returns a paginated list of prompts owned by the authenticated user. - [Get a prompt](https://docs.mka1.com/api-reference/prompts/get-a-prompt.md): Retrieves a prompt by its ID, including the active template. Pass `version` to get a specific version's template. Pass `variables` as a JSON-encoded map to render the template with substitutions. - [Update a prompt](https://docs.mka1.com/api-reference/prompts/update-a-prompt.md): Updates prompt metadata. To update the template content, create a new version instead. - [Delete a prompt](https://docs.mka1.com/api-reference/prompts/delete-a-prompt.md): Deletes a prompt and all its versions. - [Create a new version](https://docs.mka1.com/api-reference/prompts/create-a-new-version.md): Creates a new version of a prompt. The new version automatically becomes the active version. Fields not provided are carried forward from the previous version. - [List versions](https://docs.mka1.com/api-reference/prompts/list-versions.md): Returns the version history of a prompt, ordered by version number. - [Get a specific version](https://docs.mka1.com/api-reference/prompts/get-a-specific-version.md): Retrieves a specific version of a prompt by version number. - [Rollback to a version](https://docs.mka1.com/api-reference/prompts/rollback-to-a-version.md): Sets the active version of a prompt to a previous version. This does not delete newer versions — it only changes which version is active. ### Analytics #### Projects - [Create a project](https://docs.mka1.com/api-reference/analyticsprojects/create-an-analytics-project.md): Create a project in the caller's organization. Without team_id the project belongs to the authenticated team. Organization owners and admins can create a project for any team in their organization, including teams they are not a member of, or pass team_id: null for an organization-level project. Ser… - [List projects](https://docs.mka1.com/api-reference/analyticsprojects/list-accessible-analytics-projects.md): Organization owners and admins see every project in their organization: all teams' projects and organization-level projects, regardless of their active team. This also applies to an owner's or admin's API keys and exchanged JWTs, whichever team the key was issued for; use a service account for a tea… - [Get a project](https://docs.mka1.com/api-reference/analyticsprojects/get-an-analytics-project.md) - [Update a project](https://docs.mka1.com/api-reference/analyticsprojects/rename-an-active-analytics-project.md): Rename an active project. Project ownership cannot be changed. - [Archive a project](https://docs.mka1.com/api-reference/analyticsprojects/archive-an-analytics-project.md): Stop new captures and queries for this project. Previously accepted events continue processing. Archiving does not delete stored events. #### Capture keys - [Create a capture key](https://docs.mka1.com/api-reference/analyticskeys/create-a-capture-key-and-return-its-secret-once.md): Create a key that can send events to this project. Save the key from this response; its secret is only returned once. Capture keys cannot read analytics or manage projects. - [List capture keys](https://docs.mka1.com/api-reference/analyticskeys/list-capture-key-metadata.md) - [Revoke a capture key](https://docs.mka1.com/api-reference/analyticskeys/revoke-a-capture-key.md) #### Events - [Capture events](https://docs.mka1.com/api-reference/analytics/durably-accept-a-batch-of-events.md): Send a batch of events using the project's X-Analytics-Key header. A 202 response confirms the batch is stored; events become available to queries after background processing. Retry with the same idempotency_key and unchanged events if you do not receive a response. - [Query events](https://docs.mka1.com/api-reference/analytics/query-event-counts-or-unique-visitors.md): Count events or unique visitors in a time range. Optionally filter by event name or properties, group by one property, and split results into hour, day, or week buckets that start on the clock of an IANA time zone, UTC by default. Each bucket is returned as the UTC instant at which it starts. The ra… #### Event search - [Search events](https://docs.mka1.com/api-reference/analyticsevents/search-events-in-a-time-range.md): List individual events in a time range, newest first, with their properties. Optionally filter by event name, event properties, or one visitor's distinct_id. The range includes from and excludes to, and duplicate event IDs are returned once, so a search over a chart bucket's range with the same filt… #### Visitor search - [Search visitors](https://docs.mka1.com/api-reference/analyticsvisitors/search-visitors-in-a-time-range.md): List visitors with matching events in a time range, most recently active first. Each visitor is one distinct_id with the timestamps of its first and last matching event and its event count over the whole range, so for a range that receives no further events the number of visitors across all pages eq… ### Legacy APIs #### Chat Completions - [[Deprecated] Chat completions for OpenAI SDK/client usage](https://docs.mka1.com/api-reference/chat-completions/[deprecated]-chat-completions-for-openai-sdkclient-usage.md): **Deprecated: Use the Responses API (`/api/v1/llm/responses`) instead.** OpenAI-compatible chat completion endpoint designed for use with the official OpenAI client libraries (Python, Node.js, etc.). Supports both streaming and non-streaming requests by setting the `stream` parameter. This endpoint… - [[Deprecated] Streaming chat completions for generated SDK usage](https://docs.mka1.com/api-reference/chat-completions/[deprecated]-streaming-chat-completions-for-generated-sdk-usage.md): **Deprecated: Use the Responses API (`/api/v1/llm/responses`) instead.** Streaming chat completion endpoint designed for use with the generated TypeScript/JavaScript SDK from the OpenAPI specification. This endpoint uses ORPC's native streaming via async generators and returns Server-Sent Events (SS… #### Fine-Tuning - [[Deprecated] Create a fine-tuning job](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-create-a-fine-tuning-job.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** Creates a fine-tuning job which begins the process of training a new model from a given dataset. - [[Deprecated] List fine-tuning jobs](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-list-fine-tuning-jobs.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** List your organization's fine-tuning jobs. - [[Deprecated] Retrieve a fine-tuning job](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-retrieve-a-fine-tuning-job.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** Get info about a fine-tuning job. - [[Deprecated] Cancel a fine-tuning job](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-cancel-a-fine-tuning-job.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** Immediately cancel a fine-tuning job. - [[Deprecated] Pause a fine-tuning job](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-pause-a-fine-tuning-job.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** Pause a running fine-tuning job. - [[Deprecated] Resume a fine-tuning job](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-resume-a-fine-tuning-job.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** Resume a paused fine-tuning job. - [[Deprecated] List fine-tuning events](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-list-fine-tuning-events.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** Get status updates for a fine-tuning job. - [[Deprecated] List fine-tuning checkpoints](https://docs.mka1.com/api-reference/fine-tuning/[deprecated]-list-fine-tuning-checkpoints.md): **Deprecated: Use Compute jobs (`/api/v1/compute/jobs`) instead.** List checkpoints for a fine-tuning job. ### Additional APIs #### Billing - [Get apiv1budgetingbillingorg](https://docs.mka1.com/api-reference/billing/get-apiv1budgetingbillingorg.md) - [Put apiv1budgetingbillingorgenabled](https://docs.mka1.com/api-reference/billing/put-apiv1budgetingbillingorgenabled.md) - [Put apiv1budgetingbillingorgprofile](https://docs.mka1.com/api-reference/billing/put-apiv1budgetingbillingorgprofile.md) - [Post apiv1budgetingbillingorgsetup session](https://docs.mka1.com/api-reference/billing/post-apiv1budgetingbillingorgsetup-session.md) - [Post apiv1budgetingbillingorgportal session](https://docs.mka1.com/api-reference/billing/post-apiv1budgetingbillingorgportal-session.md) - [Get apiv1budgetingbillingorginvoices](https://docs.mka1.com/api-reference/billing/get-apiv1budgetingbillingorginvoices.md) #### Feature Flags - [List flags](https://docs.mka1.com/api-reference/feature-flags/list-flags.md): Every flag with a per-environment digest of its state. - [Create a flag](https://docs.mka1.com/api-reference/feature-flags/create-a-flag.md): The flag starts disabled in every environment and belongs to Default when project_id is omitted. - [List projects](https://docs.mka1.com/api-reference/feature-flags/list-projects.md) - [Create a project](https://docs.mka1.com/api-reference/feature-flags/create-a-project.md) - [Delete an empty project](https://docs.mka1.com/api-reference/feature-flags/delete-an-empty-project.md): Default cannot be deleted. Move or delete every flag before deleting another project. - [Get a project](https://docs.mka1.com/api-reference/feature-flags/get-a-project.md) - [Rename a project](https://docs.mka1.com/api-reference/feature-flags/rename-a-project.md) - [List audit entries, newest first](https://docs.mka1.com/api-reference/feature-flags/list-audit-entries-newest-first.md) - [List environments](https://docs.mka1.com/api-reference/feature-flags/list-environments.md) - [Create an environment](https://docs.mka1.com/api-reference/feature-flags/create-an-environment.md): Every existing flag gets a disabled state in the new environment. - [Delete an environment and every flag setting in it](https://docs.mka1.com/api-reference/feature-flags/delete-an-environment-and-every-flag-setting-in-it.md) - [Rename an environment](https://docs.mka1.com/api-reference/feature-flags/rename-an-environment.md) - [Evaluate every flag for an identity](https://docs.mka1.com/api-reference/feature-flags/evaluate-every-flag-for-an-identity.md): Resolves every non-archived flag of the environment for an anonymous caller, or for the identity given in the query. Sends an ETag and answers 304 to a matching If-None-Match after authenticating the environment evaluation key. - [Evaluate every flag for an identity with traits](https://docs.mka1.com/api-reference/feature-flags/evaluate-every-flag-for-an-identity-with-traits.md) - [Revoke an environment evaluation key](https://docs.mka1.com/api-reference/feature-flags/revoke-an-environment-evaluation-key.md): Revocation is idempotent while the environment exists. - [Generate or replace an environment evaluation key](https://docs.mka1.com/api-reference/feature-flags/generate-or-replace-an-environment-evaluation-key.md): Returns the new plaintext key once. Only its SHA-256 digest and a display hint are stored; generating another key immediately replaces the previous credential on this replica. - [Delete a flag and its settings in every environment](https://docs.mka1.com/api-reference/feature-flags/delete-a-flag-and-its-settings-in-every-environment.md) - [Get a flag](https://docs.mka1.com/api-reference/feature-flags/get-a-flag.md) - [Update a flag's name, description, default value, or project](https://docs.mka1.com/api-reference/feature-flags/update-a-flags-name-description-default-value-or-project.md) - [Archive a flag](https://docs.mka1.com/api-reference/feature-flags/archive-a-flag.md): Archived flags are excluded from evaluation in every environment; their settings are kept. - [Replace a flag's settings in one environment](https://docs.mka1.com/api-reference/feature-flags/replace-a-flags-settings-in-one-environment.md) - [Restore an archived flag](https://docs.mka1.com/api-reference/feature-flags/restore-an-archived-flag.md) ## OpenAPI Specs - [speakeasy](https://apigw.mka1.com/speakeasy.json) - [speakeasy](https://apigw.mka1.com/speakeasy.json?language=pt-BR) - [speakeasy](https://apigw.mka1.com/speakeasy.json?language=es)