Retrieve full content of documentation pages Run in API Explorer
Ask AI
Retrieve the full content of one or more documentation pages by their URLs, including code examples (calls, requests and responses examples).
Headers
-
A url of public portal:
- E.g. for a Documentation
https://developers.bump.sh - E.g. for a Hub
https://www.elastic.co/docs/api - E.g. for an Organization
https://apidocs.lastminute.com/
- E.g. for a Documentation
GET
/fetch
curl \
--request GET 'https://bump.sh/api/portal/v1/fetch?url=https%3A%2F%2Fone.url%2Fpath' \
--header "Portal-Url: https://developers.bump.sh/doc/workspace/"
Response examples (200)
Documentation page example
Output of the /fetch operation, when type is 'api'
{
"data": [
{
"type": "api",
"url": "https://developers.bump.sh/doc/workspace/",
"title": "Bump.sh Api",
"content": "# Bump.sh Api\nOpenAPI file: https://developers.bump.sh/doc/workspace/source.yaml\n## Description... ",
"examples": {}
}
]
Output of the /fetch operation, when type is 'operation'
{
"data": [
{
"type": "operation",
"url": "https://developers.bump.sh/doc/workspace/operation/operation-post-versions",
"title": "Create a new version",
"content": "# Create a new version\ **POST /versions** \n\nDeploy a new version for a given documentation",
"examples": {
"calls": [
{
"title": "curl",
"content": "$ curl \n --request 'https://bump.sh/api/v1/versions' \\n --header \"Authorization: Token $ACCESS_TOKEN\"…"
}
],
"requests": [
{
"title": "Create a new version on an existing documentation",
"content": "{\"definition\":{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"…\"}}}"
},
{
"title": "Create a new documentation inside a hub",
"content": "{\"definition\":{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"…\"}},\"hub\":\"my_hub_slug\"}"
}
],
"responses": [
{
"title": "generated",
"content": "{\"id\":\"2361df99-3467-4c80-a0cc-45c9fe565812\",\"doc_id\":\"3ef8f52f-9056-4113-840e-2f7183b90e06\",\"doc_public_url\":\"https://bump.sh/doc/my-own-documentation\"}",
"status": 201
},
{
"title": "generated",
"content": "{\"message\":\"You need to upgrade your subscription plan to perform this request.\"}",
"status": 400
}
]
}
}
]
}