Load all snippets

curl -X POST "https://api.buildwithfern.com/snippets/load?page=1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "orgId": "vellum",
  "apiId": "vellum-ai",
  "sdks": [
    {
      "type": "python",
      "package": "vellum-ai"
    }
  ]
}'

{
  "snippets": {
    "/v1/search": {
      "GET": [
        {
          "type": "python",
          "async_client": "import Vellum from vellum.client\nclient = Vellum(api_key=\"YOUR_API_KEY\")\nclient.search(query=\"Find documents written in the last 5 days\")\n",
          "sdk": {
            "package": "vellum-ai",
            "version": "1.2.1"
          },
          "sync_client": "import Vellum from vellum.client\nclient = Vellum(api_key=\"YOUR_API_KEY\")\nclient.search(query=\"Find documents written in the last 5 days\")\n"
        },
        {
          "type": "typescript",
          "client": "import { VellumClient } from \"vellum-ai\";\nconst vellum = VellumClient({\n  apiKey=\"YOUR_API_KEY\"\n})\nvellum.search({\n  query: \"Find documents written in the last 5 days\"\n})\n",
          "sdk": {
            "package": "vellum-ai",
            "version": "1.2.1"
          }
        }
      ]
    },
    "v1/document-indexes": {
      "POST": [
        {
          "type": "python",
          "async_client": "import VellumAsync from vellum.client\nclient = VellumAsync(api_key=\"YOUR_API_KEY\")\nawait client.document_indexes.create(name=\"meeting-reports\", status=\"ACTIVE\")\n",
          "sdk": {
            "package": "vellum-ai",
            "version": "1.2.1"
          },
          "sync_client": "import Vellum from vellum.client\nclient = Vellum(api_key=\"YOUR_API_KEY\")\nclient.document_indexes.create(name=\"meeting-reports\", status=\"ACTIVE\")\n"
        },
        {
          "type": "typescript",
          "client": "import { VellumClient } from \"vellum-ai\";\nconst vellum = VellumClient({\n  apiKey=\"YOUR_API_KEY\"\n})\nvellum.documentIndexes.create({\n  name: \"meeting-reports\",\n  status: \"ACTIVE\"\n})\n",
          "sdk": {
            "package": "vellum-ai",
            "version": "1.2.1"
          }
        }
      ]
    }
  },
  "next": 2
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Request

This endpoint expects an object.

orgIdstringOptional

If the same API is defined across multiple organization, you must specify an organization ID.

apiIdstringOptional

If you have more than one API, you must specify its ID.

sdkslist of objectsOptional

The SDKs for which to load snippets. If unspecified, snippets for the latest published SDKs will be returned.

Response

This endpoint returns an object.

snippetsmap from strings to maps from enums to lists of objects

The snippets are returned as a map of endpoint path (e.g. /api/users) to a map of endpoint method (e.g. POST) to snippets.

Allowed values:

nextinteger

If present, pass this into the page query parameter to load the next page.

Errors

400

API ID Required Error

400

Invalid Page Error

400

Org ID Required Error

401

Unauthorized Error

403

User Not IN Org Error

404

Org ID Not Found

404

Org ID and API ID Not Found

404

Sdknot Found

503

Unavailable Error

1	{
2	"snippets": {
3	"/v1/search": {
4	"GET": [
5	{
6	"type": "python",
7	"async_client": "import Vellum from vellum.client\nclient = Vellum(api_key=\"YOUR_API_KEY\")\nclient.search(query=\"Find documents written in the last 5 days\")\n",
8	"sdk": {
9	"package": "vellum-ai",
10	"version": "1.2.1"
11	},
12	"sync_client": "import Vellum from vellum.client\nclient = Vellum(api_key=\"YOUR_API_KEY\")\nclient.search(query=\"Find documents written in the last 5 days\")\n"
13	},
14	{
15	"type": "typescript",
16	"client": "import { VellumClient } from \"vellum-ai\";\nconst vellum = VellumClient({\n apiKey=\"YOUR_API_KEY\"\n})\nvellum.search({\n query: \"Find documents written in the last 5 days\"\n})\n",
17	"sdk": {
18	"package": "vellum-ai",
19	"version": "1.2.1"
20	}
21	}
22	]
23	},
24	"v1/document-indexes": {
25	"POST": [
26	{
27	"type": "python",
28	"async_client": "import VellumAsync from vellum.client\nclient = VellumAsync(api_key=\"YOUR_API_KEY\")\nawait client.document_indexes.create(name=\"meeting-reports\", status=\"ACTIVE\")\n",
29	"sdk": {
30	"package": "vellum-ai",
31	"version": "1.2.1"
32	},
33	"sync_client": "import Vellum from vellum.client\nclient = Vellum(api_key=\"YOUR_API_KEY\")\nclient.document_indexes.create(name=\"meeting-reports\", status=\"ACTIVE\")\n"
34	},
35	{
36	"type": "typescript",
37	"client": "import { VellumClient } from \"vellum-ai\";\nconst vellum = VellumClient({\n apiKey=\"YOUR_API_KEY\"\n})\nvellum.documentIndexes.create({\n name: \"meeting-reports\",\n status: \"ACTIVE\"\n})\n",
38	"sdk": {
39	"package": "vellum-ai",
40	"version": "1.2.1"
41	}
42	}
43	]
44	}
45	},
46	"next": 2
47	}