> ## Documentation Index > Fetch the complete documentation index at: https://benchgen.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Read a benchmark as a spec > The benchmark's current title, description and, when the platform still holds the sheet it was built from, its questions in the same item shape create_from_spec accepts. Benchmarks created before that sheet was kept, or from an uploaded bundle, answer with `items_readable: false` and an empty `items` list; their title and description are still returned. Only the creator and its collaborators may read a benchmark this way. Requires the `benchmark:read` scope. ## OpenAPI ````yaml GET /api/competitions/{id}/spec/ openapi: 3.0.3 info: title: BenchGen Platform API version: 1.0.0 description: >- One API for the whole BenchGen platform: model catalogue and serving, fine-tuning and benchmarks, datasets (knowledge), and billing. ## Authentication Every request uses the same credential: a platform API token sent as `Authorization: Bearer bgn_...`. Create tokens in the web app under Profile Settings > Platform API tokens (the secret is shown exactly once), or via `POST /api/tokens/` with an interactive session. Revoking a token disables it platform-wide within 60 seconds. ## Scopes A token carries scopes chosen at creation; a request outside the token's scopes gets `403` with an explanatory message. | scope | grants | |---|---| | `models:read` | read model catalogues, job status, logs, GPU info | | `models:write` | deploy, train, merge, stop models and jobs | | `benchmark:read` | read benchmark runs and results | | `benchmark:run` | launch benchmark runs | | `benchmark:create` | create benchmarks in your account (drafts, Excel, bundles, specs); counts toward the creation limit | | `benchmark:manage` | edit and delete benchmarks you own or collaborate on | | `benchmark:publish` | publish and unpublish benchmarks you own or collaborate on | | `knowledge:read` | read your datasets and fine-tuning data | | `knowledge:write` | create, edit and delete datasets and fine-tuning data | | `billing:read` | read your balance and usage | | `agents:chat` | chat with your own agents through the API | | `agents:manage` | manage your agents, knowledge bases and channels | | `admin` | everything the account can do (staff accounts only) | ## For agents This document plus `/api/llms.txt` are the machine-readable entry points. Responses are JSON. Errors use conventional status codes; the body carries `error` or `message`. Knowledge endpoints return `[{"data": [...], "meta": {...}}]`. The complete auto-generated schema of every endpoint (including internal ones) lives at `/api/public-docs.json` (Swagger 2.0); this document is the curated, stable, supported surface. contact: url: https://benchgen.com servers: - url: https://api.benchgen.com security: - platformToken: [] tags: - name: auth description: Token introspection for services and integrations - name: tokens description: Manage your platform API tokens - name: models description: Model catalogue and serving - name: finetune description: Fine-tuning jobs, inference deployments, GPUs - name: knowledge description: Datasets and fine-tuning data (knowledge API) - name: billing description: Balance and usage - name: agents description: Chat with your agents (OpenAI-compatible facade) - name: benchmark description: Public benchmark (competition) listings. paths: /api/competitions/{id}/spec/: get: tags: - benchmark summary: Read a benchmark back as a JSON spec description: >- The benchmark's current title, description and, when the platform still holds the sheet it was built from, its questions in the same item shape create_from_spec accepts. Benchmarks created before that sheet was kept, or from an uploaded bundle, answer with `items_readable: false` and an empty `items` list; their title and description are still returned. Only the creator and its collaborators may read a benchmark this way. Requires the `benchmark:read` scope. parameters: - name: id in: path required: true schema: type: integer description: Benchmark id responses: '200': description: The benchmark as a spec content: application/json: schema: type: object properties: id: type: integer title: type: string description: type: string terms: type: string contact_email: type: string format: email organization_name: type: string maxLength: 256 reward: type: string maxLength: 256 report: type: string maxLength: 256 published: type: boolean pages: type: array items: type: object required: - title properties: title: type: string maxLength: 255 content: type: string description: Markdown body; may be empty description: The benchmark's markdown tabs, in display order type: type: string enum: - question_answer - multiple_choice items_readable: type: boolean description: False when the platform cannot reconstruct the questions items: type: array items: type: object required: - question - answer properties: question: type: string answer: type: string description: >- Short text answer, or for choices the letter (A, B, ...) or the exact text of the correct choice choices: type: array items: type: string description: 2-10 options; makes the spec multiple_choice context: type: string description: Optional passage for question_answer items group: type: string description: Optional topic or category used to group results runs: type: object description: Run counts for the whole benchmark. properties: finished: type: integer active: type: integer questions_frozen: type: boolean description: >- True once the benchmark has been run, so its questions can no longer be replaced. Read this before offering a question change: edit_spec answers 409 for one. '403': description: Not your benchmark, or the token lacks benchmark:read '404': description: No such benchmark security: - platformToken: [] - interactiveToken: [] - session: [] components: securitySchemes: platformToken: type: http scheme: bearer bearerFormat: bgn_ opaque token description: >- Platform API token created under Profile Settings > Platform API tokens. Scopes are fixed at creation. interactiveToken: type: apiKey in: header name: Authorization description: >- Interactive token from `POST /api/api-token-auth/`, sent as `Authorization: Token `. Unlike a platform `bgn_` token this is a full interactive credential (it is minted from your password), so it may create and revoke platform tokens. Keep it out of CI; put a scoped `bgn_` token there instead. session: type: apiKey in: cookie name: sessionid description: >- Interactive browser session, the `sessionid` cookie Django sets when you sign in to the web app (benchgen.com). To script this endpoint, sign in in a browser and copy the `sessionid` cookie from DevTools > Application > Cookies. The recommended path is simply the web app itself: Profile Settings > Platform API tokens. Platform tokens are deliberately refused here (403), so a leaked token can never mint successors. ````