Get Run Envelope
Not available yet. This operation is part of the published contract and answers
501 not_implementeduntil it is built. The request and response shapes below are final for this contract version.
The context envelope a run used, to explain why a feature or tool was on or off.
HTTPBearerAuthorizationBearer <token>Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.
run_id*Run IduuidSparq-Workspace?stringFor a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.
uuidSuccessful Response
application/json- response
envelope_id*Envelope Iduuidcreated_at*Created Atdate-timeworkspace_id*Workspace Iduuidproject_id*Project Iduuidenvironment*EnvironmentEnvironment name, for example 'dev', 'qa', 'preprod' or 'prod'.
^[a-z][a-z0-9-]{0,30}$release_id*Release Iduuidcredential_id*Credential Iduuidenvironment_id?|nullrelease_hash?|Content hash of the Release the run used (ADR-0010 section 8).
caller*Who is calling, from the verified token and the project's claim mapping.
audience_tenant_id*Audience Tenant IdThe customer tenant, or the project's reserved tenant for calls that are not on behalf of any host customer.
uuidsurface*SurfaceWhere the caller is, as a host-defined label derived from roles, for example 'end_user' or 'tenant_admin'.
^[a-z][a-z0-9_-]{0,62}$resources?array<>features?array<>compliance_profile_version?integer|nulldata_high_water_mark?DataClassificationHighest data class the run has touched; only rises.
"public""public""internal""confidential""restricted"hints?Client-supplied hints. Untrusted; resolver input only.
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/envelope'{ "envelope_id": "cd819e97-5425-4178-8fcc-567f1dc109ce", "created_at": "2019-08-24T14:15:22Z", "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "environment": "string", "release_id": "51d53377-463c-43a4-a864-f9b3ed9178de", "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242", "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4", "release_hash": "string", "caller": { "issuer": "string", "subject": "string", "roles": [ "agent" ], "permissions": [ "string" ], "token_id": "string" }, "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26", "surface": "string", "resources": [ { "type": "string", "id": "string", "attributes": { "property1": "string", "property2": "string" } } ], "features": [ { "feature": "web_search", "enabled": true, "allowed": true, "locked": true, "decided_at": "platform", "reason": "string" } ], "compliance_profile_version": 0, "data_high_water_mark": "public", "hints": {}}Call Location GET
Where one call ran, and why (the routing decision).
Get Trace GET
> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Span content only where the client's trace content policy allows it.