curl --request POST \
--url https://three.arcprize.org/api/scorecard/open \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{
"card_id": "8bb3b1b8-4b46-4a29-a13b-ad7850a0f916"
}Open scorecard
Creates a new scorecard to aggregate statistics across one or more
plays. The server returns a card_id, which must be included in all
subsequent RESET commands and in the final /scorecard/close call.
You may attach optional metadata (URL, tags, opaque JSON) that will
be echoed back in summary responses.
curl --request POST \
--url https://three.arcprize.org/api/scorecard/open \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{
"card_id": "8bb3b1b8-4b46-4a29-a13b-ad7850a0f916"
}Authorizations
Body
Optional metadata to associate with the new scorecard.
Optional metadata sent when opening a scorecard.
Every field is optional; omit any you don't need.
Use this to attach provenance links, free-form tags, or an
"opaque" JSON blob describing the run (e.g. model settings,
hyper-parameters, experiment notes). The opaque payload must not
exceed 16 KB once serialized.
Link to code, notebook, or write-up associated with the run.
Arbitrary labels for later filtering and aggregation.
Any JSON-serializable value (≤ 16 KB). Stored verbatim; the service does not inspect or validate its structure.
Set to true to enable competition restrictions for this scorecard.
Response
scorecard successfully created.
Response returned after a successful "open scorecard" request. Contains the server-generated identifier for this tracked run.
Globally unique ID for the newly opened scorecard.
Was this page helpful?