Skip to content

MINEGHOST007/QA

Repository files navigation

Docs by LangChain

Docs

Processes the OAuth token exchange, then redirects to the frontend callback page for a consistent UI experience.

This endpoint handles the "Setup URL" callback from GitHub Apps, which is triggered when a user installs or updates their GitHub App installation.

For "update" actions (user modified repo access via GitHub), we just show a success page since no token exchange is needed.

For new installations with code/state, we process similar to the regular OAuth callback.

This is a destructive operation that:

Returns: - 200: All deployments deleted successfully - 207: Some deployments deleted successfully, some failed


Creating a listener is only allowed for LangSmith organizations with self-hosted enterprise plans. - [Delete Listener](https://docs.langchain.com/api-reference/listeners-v2/delete-listener.md): Delete a listener by ID. - [Get Listener](https://docs.langchain.com/api-reference/listeners-v2/get-listener.md): Get a listener by ID. - [List Listeners](https://docs.langchain.com/api-reference/listeners-v2/list-listeners.md): List all listeners. - [Patch Listener](https://docs.langchain.com/api-reference/listeners-v2/patch-listener.md): Patch a listener by ID. - [Create a Sandbox](https://docs.langchain.com/api-reference/sandboxes-v2/create-a-sandbox.md): Create a new SandboxClaim in tenant's namespace.

If wait_for_ready is True (default), this will block until the sandbox is ready or the timeout is reached.

The sandbox creation can fail for several reasons:

  • Image pull errors (invalid image, registry auth issues)
  • Container crashes (bad entrypoint, missing dependencies, health check failures)
  • Scheduling failures (no suitable nodes available)

Sandbox creation is subject to quota limits (count, CPU, memory) configured via Metronome org config.

On failure, the claim is automatically cleaned up and a descriptive error is returned.

Pools pre-provision sandboxes from a template for faster claim binding.

Requirements:

  • The referenced template must exist
  • The template must not have any volume mounts (volumes are stateful)

Pool creation is subject to quota limits. The total resource usage (replicas * per-replica resources) is checked against the organization's quota limits.

This creates both a PersistentVolume (PV) and PersistentVolumeClaim (PVC). The volume can then be referenced in sandbox templates.

Volume creation is subject to quota limits (count and total storage) configured via Metronome org config.

If wait_for_ready is True (default), this blocks until the PVC is bound or the timeout is reached.

This will fail if any templates reference this registry. Delete or update those templates first before deleting the registry.

This will terminate all sandboxes in the pool.

Deletion will fail if the template is in use by any sandboxes or pools.

  • Delete a Volume: Delete a persistent volume (both PV and PVC) from tenant's namespace.

This will fail if any templates reference this volume. Delete or update those templates first before deleting the volume.

Returns metadata only -- credentials are never included in responses.

  • Get a Sandbox: Get a specific Sandbox by name in tenant's namespace.

This endpoint queries the database for fast performance.

This endpoint queries the database for fast performance.

This endpoint queries the database for fast performance.

  • Get a Volume: Get a specific volume by name in the tenant's sandbox namespace.

This endpoint queries the database for fast performance.

Sandbox counts include both direct claims and warmpool replicas. For self-hosted deployments limit fields are 0 (quotas not enforced).

Returns only status and status_message -- no template resolution or full claim data. Designed for high-frequency polling by SDKs.

Returns metadata only -- credentials are never included in responses. Supports optional pagination via limit and offset query parameters.

This endpoint queries the database for fast performance. Supports optional pagination via limit and offset query parameters.

This endpoint queries the database for fast performance. Supports optional pagination via limit and offset query parameters.

This endpoint queries the database for fast performance. Supports optional pagination via limit and offset query parameters.

  • List all Volumes: List all persistent volumes in the tenant's sandbox namespace.

This endpoint queries the database for fast performance. Supports optional pagination via limit and offset query parameters.

Provide the registry URL, username, and password (or access token). The backend builds the K8s dockerconfigjson secret internally.

The registry can then be referenced in sandbox templates via the registry_name field to pull images from private registries.

You can update:

  • name: New display name (must be unique within the organization)
  • url, username, password: New credentials (all three must be provided together)
  • Update a Sandbox: Update a Sandbox's display name.

Currently only the display name can be updated.

You can update:

  • name: New display name (must be unique within the organization)
  • replicas: New replica count (scaling up is subject to quota limits)

The template reference cannot be changed after creation. Set replicas to 0 to pause the pool without deleting it.

Currently only the display name can be updated. The image, resources, and volume mounts cannot be changed after creation.

You can update:

  • name: New display name (must be unique within the organization)
  • size: New storage size (only increases allowed, cannot decrease)

The storage increase is subject to quota limits configured via Metronome org config.

Supported Methods:

  • message/send: Send a message and wait for the final Task result.
  • message/stream: Send a message and receive Server-Sent Events (SSE) JSON-RPC responses.
  • tasks/get: Fetch the current state of a Task by ID.
  • tasks/cancel: Request cancellation (currently not supported; returns an error).

LangGraph Mapping:

  • message.contextId maps to LangGraph thread_id.

Notes:

  • Only text and data parts are supported; file parts are not.

  • If message.contextId is omitted, a new context is created.

  • Text parts require the assistant input schema to include a messages field.

  • Count Assistants: Get the count of assistants matching the specified criteria.

  • Create Assistant: Create an assistant.

An initial version of the assistant will be created and the assistant is set to that version. To change versions, use the POST /assistants/{assistant_id}/latest endpoint.

All versions of the assistant will be deleted as well.

This endpoint also functions as the endpoint to list all assistants.

  • Set Latest Assistant Version: Set the latest version for an assistant.

  • Count Crons: Get the count of crons matching the specified criteria.

  • Create Cron: Create a cron to schedule runs on new threads.

  • Create Thread Cron: Create a cron to schedule runs on a thread.

  • Delete Cron: Delete a cron by ID.

  • Search Crons: Search all active crons

  • Update Cron: Update a cron job by ID.

  • MCP Get: Implemented according to the Streamable HTTP Transport specification.

  • MCP Post: Implemented according to the Streamable HTTP Transport specification. Sends a JSON-RPC 2.0 message to the server.

  • Request: Provide an object with jsonrpc, id, method, and optional params.

  • Response: Returns a JSON-RPC response or acknowledgment.

Notes:

The latest state of the thread (i.e. latest checkpoint) is returned.

  • Get Thread State At Checkpoint: Get state for a thread at a specific checkpoint.
  • Get Thread State At Checkpoint: Get state for a thread at a specific checkpoint.
  • Join Thread Stream: This endpoint streams output in real-time from a thread. The stream will include the output of each run executed sequentially on the thread and will remain open indefinitely. It is the responsibility of the calling client to close the connection.
  • Patch Thread: Update a thread.
  • Prune Threads: Prune threads by ID. The 'delete' strategy removes threads entirely. The 'keep_latest' strategy prunes old checkpoints but keeps threads and their latest state.
  • Search Threads: Search for threads.

This endpoint also functions as the endpoint to list all threads.

OpenAPI Specs

About

Deep Agents

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors