Configure Files API

The Files API from Configure — 4 operation(s) for files.

GitHub OpenAPI

Operations 5

GET /v1/profile/{userId} List profile file subtree #
DELETE /v1/profile/{userId} Delete profile file node #
GET /v1/profile/{userId}/read Read profile file node #
GET /v1/profile/{userId}/search Search profile files #
PUT /v1/profile/{userId}/write Write profile file node #

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/configure-dev:configure-dev-files-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

configure-dev-files-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Configure Dev Files API
  version: 2026-07-12
  description: 'Operations tagged Files across 2 of this provider''s published API definitions: configure-dev-openapi-original.yaml, configure-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.configure.dev
  description: Production
- url: https://configure-backend-staging.fly.dev
  description: Staging
security:
- ApiKeyAuth: []
tags:
- name: Files
paths:
  /v1/profile/{userId}:
    get:
      tags:
      - Files
      summary: List profile file subtree
      security:
      - ApiKeyAuth: []
        BearerAuth: []
      - SecretApiKeyAuth: []
        ExternalUserId: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      - $ref: '#/components/parameters/UserIdPath'
      - $ref: '#/components/parameters/FilePathQuery'
      - $ref: '#/components/parameters/DepthQuery'
      - $ref: '#/components/parameters/LimitQuery'
      responses:
        '200':
          $ref: '#/components/responses/FileList'
      operationId: getV1ProfileByUserId
      x-operation-id-source: derived
    delete:
      tags:
      - Files
      summary: Delete profile file node
      description: Requires a secret key. Federated users are namespace-fenced to /agents/{resolved-agent}; unlinked developer-scoped profiles may also manage root profile paths.
      security:
      - SecretApiKeyAuth: []
        BearerAuth: []
      - SecretApiKeyAuth: []
        ExternalUserId: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      - $ref: '#/components/parameters/UserIdPath'
      - $ref: '#/components/parameters/FilePathQueryRequired'
      responses:
        '200':
          description: Delete result.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
      operationId: deleteV1ProfileByUserId
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
  /v1/profile/{userId}/read:
    get:
      tags:
      - Files
      summary: Read profile file node
      security:
      - ApiKeyAuth: []
        BearerAuth: []
      - SecretApiKeyAuth: []
        ExternalUserId: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      - $ref: '#/components/parameters/UserIdPath'
      - $ref: '#/components/parameters/FilePathQueryRequired'
      responses:
        '200':
          description: Profile file node, null if missing or filtered.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/FileNode'
                - type: 'null'
      operationId: getV1ProfileByUserIdRead
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
  /v1/profile/{userId}/search:
    get:
      tags:
      - Files
      summary: Search profile files
      security:
      - ApiKeyAuth: []
        BearerAuth: []
      - SecretApiKeyAuth: []
        ExternalUserId: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      - $ref: '#/components/parameters/UserIdPath'
      - $ref: '#/components/parameters/SearchQuery'
      - $ref: '#/components/parameters/ScopeQuery'
      - $ref: '#/components/parameters/SearchLimitQuery'
      - $ref: '#/components/parameters/FilesOnlyQuery'
      responses:
        '200':
          $ref: '#/components/responses/FileSearch'
      operationId: getV1ProfileByUserIdSearch
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
  /v1/profile/{userId}/write:
    put:
      tags:
      - Files
      summary: Write profile file node
      description: Requires a secret key. Federated users are namespace-fenced to /agents/{resolved-agent}; unlinked developer-scoped profiles may also manage root profile paths.
      security:
      - SecretApiKeyAuth: []
        BearerAuth: []
      - SecretApiKeyAuth: []
        ExternalUserId: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      - $ref: '#/components/parameters/UserIdPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileWriteRequest'
      responses:
        '200':
          description: Write result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileWriteResult'
      operationId: putV1ProfileByUserIdWrite
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
components:
  parameters:
    FilePathQuery:
      name: path
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/FilePath'
      description: Defaults to /.
    DepthQuery:
      name: depth
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
    AgentHeader:
      name: X-Agent
      in: header
      required: false
      schema:
        $ref: '#/components/schemas/AgentName'
      description: Required when the API key's developer account owns more than one active agent.
    UserIdPath:
      name: userId
      in: path
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 255
    ScopeQuery:
      name: scope
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/FilePath'
      description: Defaults to /.
    FilePathQueryRequired:
      name: path
      in: query
      required: true
      schema:
        $ref: '#/components/schemas/FilePath'
    FilesOnlyQuery:
      name: files_only
      in: query
      required: false
      schema:
        type: boolean
        default: false
    LimitQuery:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 100
        maximum: 500
    SearchQuery:
      name: query
      in: query
      required: true
      schema:
        type: string
        minLength: 1
    SearchLimitQuery:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 10
        maximum: 50
  schemas:
    FileEntry:
      type: object
      properties:
        path:
          type: string
        type:
          type: string
        updated_at:
          type: string
          format: date-time
      additionalProperties: true
    FileWriteRequest:
      type: object
      required:
      - path
      - content
      properties:
        path:
          $ref: '#/components/schemas/FilePath'
        content:
          type: string
          maxLength: 1000000
        type:
          type: string
          enum:
          - json
          - markdown
          default: markdown
        mode:
          type: string
          enum:
          - overwrite
          - append
          - merge
          default: overwrite
    FilePath:
      type: string
      minLength: 1
      maxLength: 500
      pattern: ^/[a-zA-Z0-9._/-]*$
      example: /identity.json
    FileNode:
      type: object
      properties:
        path:
          type: string
        content:
          type: string
        type:
          type: string
          enum:
          - json
          - markdown
        updated_at:
          type: string
          format: date-time
      additionalProperties: true
    FileWriteResult:
      type: object
      properties:
        path:
          type: string
        version:
          type: integer
      additionalProperties: true
    AgentName:
      type: string
      minLength: 2
      maxLength: 63
      pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      example: your-agent
  responses:
    FileList:
      description: Profile file listing.
      content:
        application/json:
          schema:
            type: object
            properties:
              entries:
                type: array
                items:
                  $ref: '#/components/schemas/FileEntry'
              count:
                type: integer
    FileSearch:
      description: Profile file search results.
      content:
        application/json:
          schema:
            type: object
            properties:
              results:
                type: array
                items:
                  $ref: '#/components/schemas/FileEntry'
              count:
                type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Configure API key. Use sk_ on servers. pk_ is browser-safe but restricted.
    SecretApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Server-side Configure secret key, prefix sk_.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Agent-scoped Configure token from hosted Configure.link().
    ExternalUserId:
      type: apiKey
      in: header
      name: X-User-Id
      description: Stable external user ID for unlinked developer-scoped profiles. Requires sk_.
x-refined-from:
- configure-dev-openapi-original.yaml
- configure-dev-openapi.yml