Team access: List the documents in the shared base.

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? }

get/api/teams/{organization_id}/bases/{base_id}/documents

Request

  • Base URL: https://okfindex.com
  • URL: https://okfindex.com/api/teams/{organization_id}/bases/{base_id}/documents
  • Auth: none declared

Path parameters

organization_idstring required

An existing organization ID from list_knowledge_teams. The account must be an active member and OKFIndex must be enabled.

base_idstring required

The 64-character ID returned by the API.

Query parameters

afterstring

Continue from the cursor in next. Do not construct cursors.

Response

{ 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? }

nextstring nullable required

Next page URL, or null.

read_onlyboolean required

Always true. Only the personal owner can edit files or collection references.

question_price_usdstring

Price of one new answer generation in USD. Copy this value when authorizing a question.

Changes

No recorded changes to this operation across all 1 revision of this API.