Get Experiment By Name

curl --request GET \
  --url 'https://api.example.com/ai/by_name/{experiment_name}?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 By Name

Return one caller-owned experiment by exact name.

Use this tool when the caller already knows the exact experiment name and wants the full experiment object. Name matching is exact and scoped to the authenticated user, so the route does not perform fuzzy lookup across other users’ experiments.

When to Use:

Call this when the workflow is keyed by a user-provided experiment name rather than a stored ID.
Call this when the caller needs the full experiment payload, not just the dashboard URL.

Constraints:

Name matching is exact.
The route only searches the authenticated user’s experiments.

Args: user: Authenticated user resolved from the API key. db: Active database session. experiment_name: Exact experiment name to resolve.

Returns: The matching experiment object with MCP context fields populated.

Raises: HTTPException: Raised with 404 when no caller-owned experiment with the requested name exists.

GET

by_name

{experiment_name}

Get Experiment By Name

curl --request GET \
  --url 'https://api.example.com/ai/by_name/{experiment_name}?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_name

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