Get Experiment

curl --request GET \
  --url 'https://api.example.com/ai/{experiment_id}?HAIQU_API_KEY='

{
  "id": "<string>",
  "name": "<string>",
  "context": "<string>",
  "description": "",
  "creation_date": "2023-11-07T05:31:56Z",
  "tags": "",
  "circuits_count": 0,
  "jobs_count": 0,
  "last_action_date": "2023-11-07T05:31:56Z",
  "url": ""
}

API Reference

Get Experiment

Return one experiment by opaque identifier.

Use this tool when a previous MCP call has already produced an experiment_id and the caller needs the current persisted experiment object. The identifier is opaque and should be forwarded exactly as returned by prior MCP responses.

When to Use:

Call this after any MCP route returns an experiment_id and the caller needs the latest persisted experiment state.
Call this instead of get_experiment_by_name when an ID is already available.

Constraints:

Treat experiment_id as opaque and forward it unchanged.
Access is limited to experiments visible to the authenticated caller.

Args: experiment_id: Experiment identifier from an earlier MCP call. user: Authenticated user resolved from the API key. db: Active database session.

Returns: The resolved experiment object for the caller scope.

Raises: HTTPException: Raised with 404 when the experiment is not available to the caller.

GET

{experiment_id}

Get Experiment

curl --request GET \
  --url 'https://api.example.com/ai/{experiment_id}?HAIQU_API_KEY='

{
  "id": "<string>",
  "name": "<string>",
  "context": "<string>",
  "description": "",
  "creation_date": "2023-11-07T05:31:56Z",
  "tags": "",
  "circuits_count": 0,
  "jobs_count": 0,
  "last_action_date": "2023-11-07T05:31:56Z",
  "url": ""
}

Authorizations

HAIQU_API_KEY

string

query

required

Path Parameters

experiment_id

string

required

Response

Successful Response

Represent an experiment with MCP-specific context metadata.

description and creation_date remain optional for compatibility with legacy database rows.

Attributes: description: Plain-text experiment description. Optional for legacy rows that still store NULL. creation_date: Experiment creation timestamp. Optional for legacy rows that still store NULL. context: Additional plain-text guidance for AI agents consuming the experiment. url: Dashboard URL for the experiment when available.

string

required

name

string

required

context

string

required

description

string | null

default:""

creation_date

string<date-time> | null