Skip to main content
GET
Get a program

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

id
string
required

Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.

Required string length: 1 - 128
Pattern: ^[a-z0-9][a-z0-9._-]{0,127}$

Response

The program.

id
string
required

Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.

Required string length: 1 - 128
Pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
component
enum<string> | null
required

The entry component of the latest release, or null before the first release.

Available options:
rater,
guideline,
null
latestReleaseVersion
integer | null
required

Highest ready release version, or null before the first release.

Required range: x > 0
bundleId
string | null
required

Bundle of the latest release, or null before the first release.

Pattern: ^[a-f0-9]{64}$
programFingerprint
string | null
required

Fingerprint of the latest released program, or null before the first release.

uses
object[]
required

The raters the latest release’s guideline uses. Empty for a rater.

endpoints
object[]
required

The operations the latest release serves, derived from what its bundle contains. Empty before the first release.