Phraseanet Baskets API

User-curated working sets of records.

Operations 6

GET /baskets/list List baskets #
POST /baskets/add Create a basket #
GET /baskets/{basket_id}/content Get basket content #
POST /baskets/{basket_id}/setname Rename a basket #
POST /baskets/{basket_id}/setdescription Set basket description #
POST /baskets/{basket_id}/delete Delete a basket #

Documentation

Specifications

Other Resources

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/phraseanet-baskets-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.

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

OpenAPI Specification

phraseanet-baskets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Phraseanet API (v1) Baskets API
  description: Phraseanet is an open-source (GPL-v3) Digital Asset Management (DAM) platform by Alchemy.
  version: 1.5.0
  contact:
    name: Alchemy - Phraseanet
    url: https://www.phraseanet.com/
  license:
    name: GPL-3.0
    url: https://github.com/alchemy-fr/Phraseanet/blob/4.1/LICENSE
servers:
- url: https://{host}/api/v1
  description: Phraseanet instance (self-hosted)
  variables:
    host:
      default: your-phraseanet-instance
      description: Hostname of your Phraseanet installation.
security:
- oauth2: []
- oauthTokenParam: []
tags:
- name: Baskets
  description: User-curated working sets of records.
paths:
  /baskets/list:
    get:
      operationId: listBaskets
      tags:
      - Baskets
      summary: List baskets
      description: Returns the baskets owned by or shared with the authenticated user.
      responses:
        '200':
          description: A list of baskets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
  /baskets/add:
    post:
      operationId: addBasket
      tags:
      - Baskets
      summary: Create a basket
      description: Creates a new basket, optionally seeded with records.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
      responses:
        '200':
          description: The created basket.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
  /baskets/{basket_id}/content:
    get:
      operationId: getBasketContent
      tags:
      - Baskets
      summary: Get basket content
      description: Returns the records contained in a basket.
      parameters:
      - $ref: '#/components/parameters/BasketId'
      responses:
        '200':
          description: The basket content.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
  /baskets/{basket_id}/setname:
    post:
      operationId: setBasketName
      tags:
      - Baskets
      summary: Rename a basket
      description: Sets the name of a basket.
      parameters:
      - $ref: '#/components/parameters/BasketId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        '200':
          description: The updated basket.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
  /baskets/{basket_id}/setdescription:
    post:
      operationId: setBasketDescription
      tags:
      - Baskets
      summary: Set basket description
      description: Sets the description of a basket.
      parameters:
      - $ref: '#/components/parameters/BasketId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
      responses:
        '200':
          description: The updated basket.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
  /baskets/{basket_id}/delete:
    post:
      operationId: deleteBasket
      tags:
      - Baskets
      summary: Delete a basket
      description: Deletes a basket.
      parameters:
      - $ref: '#/components/parameters/BasketId'
      responses:
        '200':
          description: Deletion result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
components:
  parameters:
    BasketId:
      name: basket_id
      in: path
      required: true
      description: The basket identifier.
      schema:
        type: integer
  schemas:
    Envelope:
      type: object
      description: Standard Phraseanet response wrapper. Every response contains a meta object and a response payload.
      properties:
        meta:
          $ref: '#/components/schemas/Meta'
        response:
          type: object
          description: The endpoint-specific payload.
    Meta:
      type: object
      description: Response envelope metadata.
      properties:
        api_version:
          type: string
        request:
          type: string
        response_time:
          type: string
        http_code:
          type: integer
        error_type:
          type:
          - string
          - 'null'
        error_message:
          type:
          - string
          - 'null'
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2. Register an application in Phraseanet to obtain a client id and secret.
      flows:
        authorizationCode:
          authorizationUrl: https://your-phraseanet-instance/api/oauthv2/authorize
          tokenUrl: https://your-phraseanet-instance/api/oauthv2/token
          scopes: {}
    oauthTokenParam:
      type: apiKey
      in: query
      name: oauth_token
      description: OAuth2 access token passed as the oauth_token query parameter.