Nuxeo

Nuxeo Document API

Document Operations

GitHub OpenAPI

Operations 16

DELETE /id/{docId} Deletes a document by its id #
GET /id/{docId} Find a document by its id #
POST /id/{docId} Creates a document by its parent id #
PUT /id/{docId} Updates a document by its id #
DELETE /repo/{repoId}/id/{docId} Deletes a document by its id #
GET /repo/{repoId}/id/{docId} Find a document by its id #
POST /repo/{repoId}/id/{docId} Creates a document by its parent id #
PUT /repo/{repoId}/id/{docId} Updates a document by its id #
DELETE /path/{docPath} Deletes a document by its path #
GET /path/{docPath} Find a document by its path #
POST /path/{docPath} Creates a document by its parent path #
PUT /path/{docPath} Updates a document by its path #
DELETE /repo/{repoId}/path/{docPath} Deletes a document by its path #
GET /repo/{repoId}/path/{docPath} Find a document by its path #
POST /repo/{repoId}/path/{docPath} Creates a document by its parent path #
PUT /repo/{repoId}/path/{docPath} Updates a document by its path #

Documentation

📖
Documentation
https://doc.nuxeo.com/nxdoc/rest-api/
📖
Authentication
https://doc.nuxeo.com/rest-api/1/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nuxeo/refs/heads/main/openapi/nuxeo-document-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://github.com/nuxeo-sandbox/nuxeo-openapi
🔗
Swagger
https://github.com/nuxeo/nuxeo-rest-api-swagger-doc
🔗
Endpoints
https://doc.nuxeo.com/nxdoc/rest-api-endpoints/
🔗
HowTos
https://doc.nuxeo.com/nxdoc/rest-api-howtos/
🔗
Automation
https://doc.nuxeo.com/nxdoc/content-automation-concepts/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nuxeo-document-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nuxeo-document-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: LTS 2021
  title: Nuxeo Platform ACL Document API
  termsOfService: https://www.nuxeo.com/about/why-nuxeo/
  contact:
    email: support@nuxeo.com
    url: https://www.nuxeo.com/contact/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://d1q6f0aelx0por.cloudfront.net/product-logos/library-nuxeo-logo.png
  description: '# Nuxeo Platform https://www.nuxeo.com/

    OpenAPI 3.0 Specification for the Nuxeo Platform.'
servers:
- url: https://{host}:{port}/nuxeo/api/v1
  variables:
    host:
      default: demo.nuxeo.com
      description: Nuxeo Platform Host
    port:
      default: '443'
      description: Nuxeo Platform Port
- url: https://nightly.nuxeo.com/nuxeo/api/v1
  description: Nuxeo Platform Nightly Test Server
tags:
- name: Document
  description: Document Operations
paths:
  /id/{docId}:
    delete:
      operationId: DocumentIdDelete
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Deletes a document by its id
      tags:
      - Document
    get:
      operationId: DocumentIdGet
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Find a document by its id
      tags:
      - Document
    post:
      operationId: DocumentIdPost
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Creates a document by its parent id
      tags:
      - Document
    put:
      operationId: DocumentIdPut
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission can be updated. Only the properties part of the document object is taken into account for update
      summary: Updates a document by its id
      tags:
      - Document
  /repo/{repoId}/id/{docId}:
    delete:
      operationId: RepoIdDocumentIdDelete
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Deletes a document by its id
      tags:
      - Document
    get:
      operationId: RepoIdDocumentIdGet
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Find a document by its id
      tags:
      - Document
    post:
      operationId: RepoIdDocumentIdPost
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Creates a document by its parent id
      tags:
      - Document
    put:
      operationId: RepoIdDocumentIdPut
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission can be updated. Only the properties part of the document object is taken into account for update
      summary: Updates a document by its id
      tags:
      - Document
  /path/{docPath}:
    delete:
      operationId: DocumentPathDelete
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission can be deleted
      summary: Deletes a document by its path
      tags:
      - Document
    get:
      operationId: DocumentPathGet
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Find a document by its path
      tags:
      - Document
    post:
      operationId: DocumentPathPost
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Creates a document by its parent path
      tags:
      - Document
    put:
      operationId: DocumentPathPut
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission can be updated. Only the properties part of the document object is taken into account for update
      summary: Updates a document by its path
      tags:
      - Document
  /repo/{repoId}/path/{docPath}:
    delete:
      operationId: RepoIdDocumentPathDelete
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Deletes a document by its path
      tags:
      - Document
    get:
      operationId: RepoIdDocumentPathGet
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission to see will be returned
      summary: Find a document by its path
      tags:
      - Document
    post:
      operationId: RepoIdDocumentPathPost
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Creates a document by its parent path
      tags:
      - Document
    put:
      operationId: RepoIdDocumentPathPut
      parameters:
      - description: The name of the repository
        in: path
        name: repoId
        required: true
        schema:
          type: string
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Schemas to be included in response
        in: header
        name: X-NXDocumentProperties
        required: false
        schema:
          type: string
      - description: Categories to be included in context parameters map
        in: header
        name: X-NXContext-Category
        required: false
        schema:
          type: string
      - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none'
        in: header
        name: X-Versioning-Option
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: Only documents which you have permission can be updated. Only the properties part of the document object is taken into account for update
      summary: Updates a document by its path
      tags:
      - Document
components:
  schemas:
    Property:
      properties:
        context:
          type: object
          uniqueItems: false
        params:
          type: object
          uniqueItems: false
      required:
      - context
      - params
      uniqueItems: false
    document:
      properties:
        changeToken:
          type: string
          uniqueItems: false
        contextParameters:
          type: object
          uniqueItems: false
        entity-type:
          type: string
          uniqueItems: false
        facets:
          items:
            type: string
          type: array
        lastModified:
          format: date
          type: string
          uniqueItems: false
        path:
          type: string
          uniqueItems: false
        properties:
          items:
            $ref: '#/components/schemas/Property'
          type: object
          uniqueItems: true
        repository:
          type: string
          uniqueItems: false
        state:
          type: string
          uniqueItems: false
        title:
          type: string
          uniqueItems: false
        type:
          type: string
          uniqueItems: false
        uid:
          type: string
          uniqueItems: false
        versionLabel:
          type: string
          uniqueItems: false
      required:
      - entity-type
      uniqueItems: false
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    token:
      type: apiKey
      in: header
      name: X-Authentication-Token
externalDocs:
  description: Nuxeo Documentation
  url: https://doc.nuxeo.com/