research

Get study designs

Deprecated: use research.study-designs.get.v2 (research_study_designs_get_v2), which also names a question's video; this version leaves a video out, so a question that shows one reads as showing no file. Get a Research study design the signed-in user started, by the Idempotency-Key of its research.study-designs.start request: pending, failed, or ready with Alpha's reply and the study. Reading makes no model call. A key that started no design of yours is not found.

get/api/v1/research/study-designs/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-designs/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

The Idempotency-Key of the research.study-designs.start request.

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

runIdstring uuid required

The billing run that pays for the design in Alpha credits.

status'pending' | 'failed' | 'ready' required
failureDisposition'transient' | 'repairable_schema' | 'deterministic' | 'cancelled' | 'unknown' | 'repairable_domain'

Why a failed design stopped, once its run settled: transient is worth retrying; deterministic and repairable_schema need a changed request.

Changes

No recorded changes to this operation across all 1 revision of this API.