cc
GET /samples/{sample_id}
Bearer auth

Path parameters

  • sample_id integer Required

    Numeric sample or regression result ID

    Minimum value is 1.

Responses

  • 200 application/json

    Media sample metadata

    Hide response attributes Show response attributes object
    • sample_id integer Required

      Minimum value is 1.

    • sha256 string Required

      Format should match the following pattern: ^[a-fA-F0-9]{64}$.

    • name string

      Maximum length is 255.

    • extension string

      Maximum length is 10.

    • tags array[string]

      Not more than 50 elements. Maximum length of each is 50.

    • media_info object

      Additional properties are allowed.

    • notes string | null

      Maximum length is 1000.
  • 401 application/json

    Missing, expired, or invalid bearer token

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • 404 application/json

    Resource not found

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • 429 application/json

    Too many requests. Retry after the indicated number of seconds.

    Hide headers attributes Show headers attributes
    • Retry-After integer

      Seconds to wait before retrying

    • X-RateLimit-Limit

      Maximum requests allowed in the current window

    • X-RateLimit-Remaining

      Requests remaining in the current window

    • X-RateLimit-Reset

      Unix timestamp when the rate limit window resets

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • default application/json

    Unexpected server error

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
GET /samples/{sample_id} 
curl \
 --request GET 'https://sampleplatform.ccextractor.org/api/v1/samples/{sample_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "sample_id": 42,
  "sha256": "string",
  "name": "string",
  "extension": "string",
  "tags": [
    "string"
  ],
  "media_info": {},
  "notes": "string"
}
Response examples (401) 
{
  "code": "unauthorized",
  "message": "Bearer token is missing, expired, or invalid.",
  "details": {}
}
Response examples (404) 
{
  "code": "not_found",
  "message": "Run 9317 not found.",
  "details": {
    "resource": "run",
    "id": 9317
  }
}
Response examples (429) 
{
  "code": "rate_limited",
  "message": "Rate limit exceeded. Retry after 30 seconds.",
  "details": {
    "retry_after": 30,
    "limit": 120,
    "window": "60s"
  }
}
Response examples (default) 
{
  "code": "not_found",
  "message": "Run 9317 not found.",
  "details": {}
}