Get file by SHA256 | HiddenLayer Documentation

{
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string",
  "file_instances": [
    {
      "instance": {
        "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "revision_id": "550e8400-e29b-41d4-a716-446655440000",
        "path": "onnx_files/model.onnx",
        "source": "github",
        "tags": [
          "code",
          "onnx"
        ],
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z",
        "committed_date": "2024-01-10T08:00:00Z"
      },
      "repo_revision": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "repository_id": "550e8400-e29b-41d4-a716-446655440001",
        "commit_hash": "a1b2c3d4e5f6789012345678901234567890abcd",
        "metadata": {
          "branch": "main",
          "author": "john.doe"
        },
        "fetched_at": "2024-01-15T10:30:00Z",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      },
      "repository": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "owner_id": "550e8400-e29b-41d4-a716-446655440001",
        "url": "https://github.com/user/my-awesome-project",
        "architectures": [
          "transformer",
          "cnn"
        ],
        "modalities": [
          "text",
          "image"
        ],
        "tags": [
          "machine-learning",
          "nlp"
        ],
        "metadata": {
          "language": "Python",
          "framework": "PyTorch"
        },
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z",
        "name": "my-awesome-project",
        "description": "An awesome project for doing awesome things"
      },
      "repo_owner": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "handle": "john_doe",
        "kind": "user",
        "homepage_url": "https://johndoe.com",
        "trust_level": "verified",
        "country": "US",
        "source": "github",
        "tags": [
          "developer",
          "ml-engineer"
        ],
        "metadata": {
          "github_followers": 1000,
          "company": "Tech Corp"
        },
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z",
        "display_name": "John Doe"
      },
      "licenses": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "MIT License",
          "version": "1.0",
          "url": "https://opensource.org/licenses/MIT",
          "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z",
          "spdx_id": "MIT",
          "description": "A permissive license that allows for commercial use"
        }
      ],
      "use_policies": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "title": "Commercial Use Policy",
          "url": "https://example.com/use-policy",
          "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z",
          "description": "Policy governing commercial use of the content"
        }
      ]
    }
  ]
}

Retrieve detailed file information including all associated instances, repositories, and metadata

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sha256stringRequiredformat: "^[a-fA-F0-9]{64}$"

SHA256 hash of the file (64 hexadecimal characters)

Query parameters

page_sizeintegerOptional1-100Defaults to 25

Number of items to return per page

cursorstringOptional

Cursor for pagination, used to navigate through pages of results

Response

File found and returned successfully

firststring

Pagination cursor pointing to the first page.

prevstring

Pagination cursor pointing to the previous page.

nextstring

Pagination cursor pointing to the next page.

laststringOptional

Pagination cursor pointing to the last page.

file_instanceslist of objectsOptional

Errors

422

Unprocessable Entity Error