naftiko: 1.0.0-alpha2
info:
  label: Portkey API — Vector Stores
  description: 'Portkey API — Vector Stores. 13 operations. Lead operation: Returns a list of vector stores.. Self-contained
    Naftiko capability covering one Portkey business surface.'
  tags:
  - Portkey
  - Vector Stores
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTKEY_API_KEY: PORTKEY_API_KEY
capability:
  consumes:
  - type: http
    namespace: portkey-vector-stores
    baseUri: https://api.portkey.ai/v1
    description: Portkey API — Vector Stores business capability. Self-contained, no shared references.
    resources:
    - name: vector_stores
      path: /vector_stores
      operations:
      - name: listvectorstores
        method: GET
        description: Returns a list of vector stores.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 20.
        - name: order
          in: query
          type: string
          description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending
            order.
        - name: after
          in: query
          type: string
          description: A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance,
            if you make a list request and receive 100 objects, e
        - name: before
          in: query
          type: string
          description: 'A cursor for use in pagination. `before` is an object ID that defines your place in the list. For
            instance, if you make a list request and receive 100 objects, '
      - name: createvectorstore
        method: POST
        description: Create a vector store.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: vector_stores-vector_store_id
      path: /vector_stores/{vector_store_id}
      operations:
      - name: getvectorstore
        method: GET
        description: Retrieves a vector store.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store to retrieve.
          required: true
      - name: modifyvectorstore
        method: POST
        description: Modifies a vector store.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store to modify.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletevectorstore
        method: DELETE
        description: Delete a vector store.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store to delete.
          required: true
    - name: vector_stores-vector_store_id-file_batches
      path: /vector_stores/{vector_store_id}/file_batches
      operations:
      - name: createvectorstorefilebatch
        method: POST
        description: Create a vector store file batch.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store for which to create a File Batch.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: vector_stores-vector_store_id-file_batches-batch_id
      path: /vector_stores/{vector_store_id}/file_batches/{batch_id}
      operations:
      - name: getvectorstorefilebatch
        method: GET
        description: Retrieves a vector store file batch.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store that the file batch belongs to.
          required: true
        - name: batch_id
          in: path
          type: string
          description: The ID of the file batch being retrieved.
          required: true
    - name: vector_stores-vector_store_id-file_batches-batch_id-cancel
      path: /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
      operations:
      - name: cancelvectorstorefilebatch
        method: POST
        description: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon
          as possible.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store that the file batch belongs to.
          required: true
        - name: batch_id
          in: path
          type: string
          description: The ID of the file batch to cancel.
          required: true
    - name: vector_stores-vector_store_id-file_batches-batch_id-files
      path: /vector_stores/{vector_store_id}/file_batches/{batch_id}/files
      operations:
      - name: listfilesinvectorstorebatch
        method: GET
        description: Returns a list of vector store files in a batch.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store that the files belong to.
          required: true
        - name: batch_id
          in: path
          type: string
          description: The ID of the file batch that the files belong to.
          required: true
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 20.
        - name: order
          in: query
          type: string
          description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending
            order.
        - name: after
          in: query
          type: string
          description: A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance,
            if you make a list request and receive 100 objects, e
        - name: before
          in: query
          type: string
          description: 'A cursor for use in pagination. `before` is an object ID that defines your place in the list. For
            instance, if you make a list request and receive 100 objects, '
        - name: filter
          in: query
          type: string
          description: Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
    - name: vector_stores-vector_store_id-files
      path: /vector_stores/{vector_store_id}/files
      operations:
      - name: listvectorstorefiles
        method: GET
        description: Returns a list of vector store files.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store that the files belong to.
          required: true
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 20.
        - name: order
          in: query
          type: string
          description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending
            order.
        - name: after
          in: query
          type: string
          description: A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance,
            if you make a list request and receive 100 objects, e
        - name: before
          in: query
          type: string
          description: 'A cursor for use in pagination. `before` is an object ID that defines your place in the list. For
            instance, if you make a list request and receive 100 objects, '
        - name: filter
          in: query
          type: string
          description: Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
      - name: createvectorstorefile
        method: POST
        description: Create a vector store file by attaching a [File](https://platform.openai.com/docs/api-reference/files)
          to a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store for which to create a File.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: vector_stores-vector_store_id-files-file_id
      path: /vector_stores/{vector_store_id}/files/{file_id}
      operations:
      - name: getvectorstorefile
        method: GET
        description: Retrieves a vector store file.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store that the file belongs to.
          required: true
        - name: file_id
          in: path
          type: string
          description: The ID of the file being retrieved.
          required: true
      - name: deletevectorstorefile
        method: DELETE
        description: Delete a vector store file. This will remove the file from the vector store but the file itself will
          not be deleted. To delete the file, use the [delete file](https://platform.openai.com/docs/api-reference/files/delete)
          endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vector_store_id
          in: path
          type: string
          description: The ID of the vector store that the file belongs to.
          required: true
        - name: file_id
          in: path
          type: string
          description: The ID of the file to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTKEY_API_KEY}}'
  exposes:
  - type: rest
    namespace: portkey-vector-stores-rest
    port: 8080
    description: REST adapter for Portkey API — Vector Stores. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/vector-stores
      name: vector-stores
      description: REST surface for vector_stores.
      operations:
      - method: GET
        name: listvectorstores
        description: Returns a list of vector stores.
        call: portkey-vector-stores.listvectorstores
        with:
          limit: rest.limit
          order: rest.order
          after: rest.after
          before: rest.before
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createvectorstore
        description: Create a vector store.
        call: portkey-vector-stores.createvectorstore
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}
      name: vector-stores-vector-store-id
      description: REST surface for vector_stores-vector_store_id.
      operations:
      - method: GET
        name: getvectorstore
        description: Retrieves a vector store.
        call: portkey-vector-stores.getvectorstore
        with:
          vector_store_id: rest.vector_store_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: modifyvectorstore
        description: Modifies a vector store.
        call: portkey-vector-stores.modifyvectorstore
        with:
          vector_store_id: rest.vector_store_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletevectorstore
        description: Delete a vector store.
        call: portkey-vector-stores.deletevectorstore
        with:
          vector_store_id: rest.vector_store_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}/file-batches
      name: vector-stores-vector-store-id-file-batches
      description: REST surface for vector_stores-vector_store_id-file_batches.
      operations:
      - method: POST
        name: createvectorstorefilebatch
        description: Create a vector store file batch.
        call: portkey-vector-stores.createvectorstorefilebatch
        with:
          vector_store_id: rest.vector_store_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}/file-batches/{batch-id}
      name: vector-stores-vector-store-id-file-batches-batch-id
      description: REST surface for vector_stores-vector_store_id-file_batches-batch_id.
      operations:
      - method: GET
        name: getvectorstorefilebatch
        description: Retrieves a vector store file batch.
        call: portkey-vector-stores.getvectorstorefilebatch
        with:
          vector_store_id: rest.vector_store_id
          batch_id: rest.batch_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}/file-batches/{batch-id}/cancel
      name: vector-stores-vector-store-id-file-batches-batch-id-cancel
      description: REST surface for vector_stores-vector_store_id-file_batches-batch_id-cancel.
      operations:
      - method: POST
        name: cancelvectorstorefilebatch
        description: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon
          as possible.
        call: portkey-vector-stores.cancelvectorstorefilebatch
        with:
          vector_store_id: rest.vector_store_id
          batch_id: rest.batch_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}/file-batches/{batch-id}/files
      name: vector-stores-vector-store-id-file-batches-batch-id-files
      description: REST surface for vector_stores-vector_store_id-file_batches-batch_id-files.
      operations:
      - method: GET
        name: listfilesinvectorstorebatch
        description: Returns a list of vector store files in a batch.
        call: portkey-vector-stores.listfilesinvectorstorebatch
        with:
          vector_store_id: rest.vector_store_id
          batch_id: rest.batch_id
          limit: rest.limit
          order: rest.order
          after: rest.after
          before: rest.before
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}/files
      name: vector-stores-vector-store-id-files
      description: REST surface for vector_stores-vector_store_id-files.
      operations:
      - method: GET
        name: listvectorstorefiles
        description: Returns a list of vector store files.
        call: portkey-vector-stores.listvectorstorefiles
        with:
          vector_store_id: rest.vector_store_id
          limit: rest.limit
          order: rest.order
          after: rest.after
          before: rest.before
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createvectorstorefile
        description: Create a vector store file by attaching a [File](https://platform.openai.com/docs/api-reference/files)
          to a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).
        call: portkey-vector-stores.createvectorstorefile
        with:
          vector_store_id: rest.vector_store_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vector-stores/{vector-store-id}/files/{file-id}
      name: vector-stores-vector-store-id-files-file-id
      description: REST surface for vector_stores-vector_store_id-files-file_id.
      operations:
      - method: GET
        name: getvectorstorefile
        description: Retrieves a vector store file.
        call: portkey-vector-stores.getvectorstorefile
        with:
          vector_store_id: rest.vector_store_id
          file_id: rest.file_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletevectorstorefile
        description: Delete a vector store file. This will remove the file from the vector store but the file itself will
          not be deleted. To delete the file, use the [delete file](https://platform.openai.com/docs/api-reference/files/delete)
          endpoint.
        call: portkey-vector-stores.deletevectorstorefile
        with:
          vector_store_id: rest.vector_store_id
          file_id: rest.file_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portkey-vector-stores-mcp
    port: 9090
    transport: http
    description: MCP adapter for Portkey API — Vector Stores. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: returns-list-vector-stores
      description: Returns a list of vector stores.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-vector-stores.listvectorstores
      with:
        limit: tools.limit
        order: tools.order
        after: tools.after
        before: tools.before
      outputParameters:
      - type: object
        mapping: $.
    - name: create-vector-store
      description: Create a vector store.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-vector-stores.createvectorstore
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-vector-store
      description: Retrieves a vector store.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-vector-stores.getvectorstore
      with:
        vector_store_id: tools.vector_store_id
      outputParameters:
      - type: object
        mapping: $.
    - name: modifies-vector-store
      description: Modifies a vector store.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-vector-stores.modifyvectorstore
      with:
        vector_store_id: tools.vector_store_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-vector-store
      description: Delete a vector store.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portkey-vector-stores.deletevectorstore
      with:
        vector_store_id: tools.vector_store_id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-vector-store-file-batch
      description: Create a vector store file batch.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-vector-stores.createvectorstorefilebatch
      with:
        vector_store_id: tools.vector_store_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-vector-store-file-batch
      description: Retrieves a vector store file batch.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-vector-stores.getvectorstorefilebatch
      with:
        vector_store_id: tools.vector_store_id
        batch_id: tools.batch_id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-vector-store-file-batch
      description: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon
        as possible.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-vector-stores.cancelvectorstorefilebatch
      with:
        vector_store_id: tools.vector_store_id
        batch_id: tools.batch_id
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-list-vector-store-files
      description: Returns a list of vector store files in a batch.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-vector-stores.listfilesinvectorstorebatch
      with:
        vector_store_id: tools.vector_store_id
        batch_id: tools.batch_id
        limit: tools.limit
        order: tools.order
        after: tools.after
        before: tools.before
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-list-vector-store-files-2
      description: Returns a list of vector store files.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-vector-stores.listvectorstorefiles
      with:
        vector_store_id: tools.vector_store_id
        limit: tools.limit
        order: tools.order
        after: tools.after
        before: tools.before
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-vector-store-file-attaching
      description: Create a vector store file by attaching a [File](https://platform.openai.com/docs/api-reference/files)
        to a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-vector-stores.createvectorstorefile
      with:
        vector_store_id: tools.vector_store_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-vector-store-file
      description: Retrieves a vector store file.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-vector-stores.getvectorstorefile
      with:
        vector_store_id: tools.vector_store_id
        file_id: tools.file_id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-vector-store-file-this
      description: Delete a vector store file. This will remove the file from the vector store but the file itself will not
        be deleted. To delete the file, use the [delete file](https://platform.openai.com/docs/api-reference/files/delete)
        endpoint.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portkey-vector-stores.deletevectorstorefile
      with:
        vector_store_id: tools.vector_store_id
        file_id: tools.file_id
      outputParameters:
      - type: object
        mapping: $.