My App
API ReferenceExperiments

Preview Experiment Creation

Preview which conversations an experiment would include.

Test your filters before committing to an experiment. See a sample of matching conversations and the total count to estimate scope and cost.

GET
/v1/experiments/preview

Query Parameters

created_at_gte?|

Filter conversations created on or after this time (ISO 8601)

created_at_lte?|

Filter conversations created on or before this time (ISO 8601)

model?|

Filter by model used in generation

Header Parameters

x-workspace-id?|

Workspace UUID to operate within. Required for session auth and user-scoped API keys. Optional for workspace-scoped API keys (uses key's workspace if omitted).

Response Body

application/json

application/json

curl -X GET "https://loading/v1/experiments/preview"
{
  "conversations": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "external_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "message_count": 0,
      "annotation_count": 0,
      "messages": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "role": "string",
          "parts": [
            {}
          ],
          "sequence_number": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "generation": {
            "model": "string",
            "input_tokens": 0,
            "output_tokens": 0,
            "cost_usd": 0,
            "response_id": "string",
            "provider": "string",
            "finish_reasons": [
              "string"
            ],
            "agent_description": "string",
            "agent_id": "string",
            "agent_name": "string"
          }
        }
      ]
    }
  ],
  "total_count": 0,
  "sample_size": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}