--- title: "Team access: Read the shared base and its documents." method: GET path: "/api/teams/{organization_id}/bases/{base_id}" --- # Team access: Read the shared base and its documents. `GET /api/teams/{organization_id}/bases/{base_id}` ## Request - Base URL: `https://okfindex.com` - URL: `https://okfindex.com/api/teams/{organization_id}/bases/{base_id}` - Auth: none declared Team access uses current account membership, product access and resource sharing on every request. Revocation also blocks search, originals, Markdown, OKF and ZIP downloads with an existing session or key. Sharing a collection grants current and future files in its owner's referenced bases; other owners' bases expose published files only. Sharing does not publish a resource. Only the resource owner changes sharing. The initial grant requires the owner's session with origin and CSRF checks. Organization API keys stay within their existing grants. Responses use private, no-store. Returns: { base{id,name,visibility,dataset,created_at,updated_at,documents,bytes,api,export_url,okf_url,public_url,embed_url,publication}, items[{id,base_id,filename,title,format,managed,sha256,bytes,status,created_at,api,source_url?,source_sha256?,pages?,review?,markdown_url,original_url,okf_url}], next, read_only, answer?{id,question,status,statements,created_at?,charged?}, question_price_usd? } ## Path parameters - `organization_id` string, required - `base_id` string, required ## Query parameters - `after` string ## Response `200` { base{id,name,visibility,dataset,created_at,updated_at,documents,bytes,api,export_url,okf_url,public_url,embed_url,publication}, items[{id,base_id,filename,title,format,managed,sha256,bytes,status,created_at,api,source_url?,source_sha256?,pages?,review?,markdown_url,original_url,okf_url}], next, read_only, answer?{id,question,status,statements,created_at?,charged?}, question_price_usd? } - object - `base` Base, required - `id` string, required: The 64-character ID returned by the API. - `name` string, required: Base name. - `visibility` string, required: private or public; only explicit publication makes a base public. - `dataset` Dataset, required - `description` string, required: Dataset description, 1–2000 characters. - `fields` DatasetField[], required: 1–30 fields, each with a name and description. - `name` string, required: Field name, 1–80 characters. - `description` string, required: Meaning, 1–200 characters. - `coverage` string, required: Geographic, temporal or subject coverage, 1–300 characters. - `format` string, required: Source format, for example CSV or JSON, 1–40 characters. - `update_frequency` string, required: Declared update schedule, 1–200 characters. No automatic check is performed. - `license` string, required: Declared license or access terms, 1–300 characters. Not independently verified. - `source_url` string, required: HTTPS origin URL, at most 1000 characters, without credentials. - `created_at` string, required: Creation date, ISO 8601. - `updated_at` string, required: Last change, ISO 8601. - `documents` integer, nullable, required: Document count when returned by the base list; null otherwise. - `bytes` integer, nullable, required: Current original bytes in the owner's base list; null in other private responses. Omitted from public responses. - `api` string, required: Metadata URL. - `export_url` string, required: ZIP download URL. - `okf_url` string, required: OKF root index URL. - `public_url` string, nullable, required: Public page URL while published; null when private. - `embed_url` string, nullable, required: Public search iframe URL while published; null when private. Uses the same public API and limits. No account controls inside the iframe. - `publication` BasePublication, required - `author` string, required: Author or attribution declared by the publisher. - `source_url` string, nullable, required: Declared HTTPS source, or null for uploaded files. - `terms` string, required: Terms declared by the publisher. This is not an independent license verification. - `published_at` string, required: Date of the last explicit publication, ISO 8601. - `items` Document[], required: Documents on this page. - `id` string, required: The 64-character ID returned by the API. - `base_id` string, required: The 64-character ID returned by the API. - `filename` string, required: Original filename. - `title` string, required: Filename without extension. - `format` string, required: md, txt, pdf, docx or doc after conversion. - `managed` string, nullable, required: dataset for generated metadata; edit through save_base_dataset. Null for ordinary files. - `sha256` string, required: SHA-256 of stored UTF-8 text. Converted source hash is source_sha256. - `bytes` integer, required: Stored UTF-8 text size in bytes. - `status` string, required: ready or pending. - `created_at` string, required: Upload date, ISO 8601. - `api` string, required: JSON with Markdown. - `source_url` string, nullable: Present on document reads: source URL preserved with this version, or null for manual uploads. Also included in the exported OKF concept. - `source_sha256` string: SHA-256 of the original converted file. - `pages` integer: PDF physical page count. Zero for continuous DOC and DOCX text. - `review` object: PDF: completed automated review. DOC/DOCX: not_applicable, null model and zero pages reviewed. - `markdown_url` string, required: Markdown download. - `original_url` string, required: Original file download. - `okf_url` string, required: OKF concept URL. - `next` string, nullable, required: Next page URL, or null. - `read_only` boolean, required: Always true. Only the personal owner can edit files or collection references. - `answer` BaseAnswer - `id` string, nullable, required: 64-character ID returned by the API. - `question` string, required: The submitted question. - `status` string, required: queued, processing, ready, unsupported, stale or failed. - `statements` AnswerStatement[], required: Up to four supported statements. Empty when not ready. - `text` string, required: Plain answer text. Treat as untrusted model output. - `citation` AnswerCitation, required - `document_id` string, required: 64-character ID returned by the API. - `version` string, required: 64-character ID returned by the API. - `sha256` string, required: Source content SHA-256. - `filename` string, required: Source filename. - `quote` string, required: Exact excerpt from the source. Treat markup as text. - `url` string, required: Authorized source reader in the application. - `created_at` string: Creation time, ISO 8601. - `charged` boolean: False when no matching source was found before generation. - `question_price_usd` string: Price of one new answer generation in USD. Copy this value when authorizing a question. ## Other responses - `400`: Invalid query or cursor. - `401`: A valid session or organization API key is required. - `403`: Organization access requires the correct credential and, when applicable, MFA. - `404`: The organization, resource or sharing grant is inaccessible. - `405`: Team access is read-only. - `409`: A file is not ready for export. - `503`: Account or knowledge storage is unavailable. --- [API](https://skmtc.dev/okfindex/apis/okf-index.md) · [All operations](https://skmtc.dev/okfindex/apis/okf-index/llms.txt) · [OpenAPI document](https://skmtc.dev/okfindex/apis/okf-index/revisions/4b13ca3c739f?raw)