Parse an OpenAPI spec by URL
curl --request POST \
--url https://your-instance.example.com/api/parse-openapi \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"openApiUrl": "https://example.com/openapi.json",
"projectTitle": "My API"
}
'import requests
url = "https://your-instance.example.com/api/parse-openapi"
payload = {
"openApiUrl": "https://example.com/openapi.json",
"projectTitle": "My API"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({openApiUrl: 'https://example.com/openapi.json', projectTitle: 'My API'})
};
fetch('https://your-instance.example.com/api/parse-openapi', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/parse-openapi",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'openApiUrl' => 'https://example.com/openapi.json',
'projectTitle' => 'My API'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/parse-openapi"
payload := strings.NewReader("{\n \"openApiUrl\": \"https://example.com/openapi.json\",\n \"projectTitle\": \"My API\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/parse-openapi")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"openApiUrl\": \"https://example.com/openapi.json\",\n \"projectTitle\": \"My API\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/parse-openapi")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"openApiUrl\": \"https://example.com/openapi.json\",\n \"projectTitle\": \"My API\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Parse queued",
"project": "/your-org/your-repo",
"queueId": 5,
"position": 1
}{
"error": "repoUrl is required"
}{
"error": "Authentication required"
}{
"error": "An unexpected error occurred"
}Parse
Parse an OpenAPI spec by URL
Queue a remote OpenAPI specification (JSON or YAML) for parsing and indexing
POST
/
parse-openapi
Parse an OpenAPI spec by URL
curl --request POST \
--url https://your-instance.example.com/api/parse-openapi \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"openApiUrl": "https://example.com/openapi.json",
"projectTitle": "My API"
}
'import requests
url = "https://your-instance.example.com/api/parse-openapi"
payload = {
"openApiUrl": "https://example.com/openapi.json",
"projectTitle": "My API"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({openApiUrl: 'https://example.com/openapi.json', projectTitle: 'My API'})
};
fetch('https://your-instance.example.com/api/parse-openapi', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/parse-openapi",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'openApiUrl' => 'https://example.com/openapi.json',
'projectTitle' => 'My API'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/parse-openapi"
payload := strings.NewReader("{\n \"openApiUrl\": \"https://example.com/openapi.json\",\n \"projectTitle\": \"My API\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/parse-openapi")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"openApiUrl\": \"https://example.com/openapi.json\",\n \"projectTitle\": \"My API\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/parse-openapi")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"openApiUrl\": \"https://example.com/openapi.json\",\n \"projectTitle\": \"My API\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Parse queued",
"project": "/your-org/your-repo",
"queueId": 5,
"position": 1
}{
"error": "repoUrl is required"
}{
"error": "Authentication required"
}{
"error": "An unexpected error occurred"
}Authorizations
API key generated from Personal Settings. See Authentication.
Body
application/json
Response
Parse job accepted and queued
Example:
"Parse queued"
Project identifier assigned to this library (e.g. /your-org/your-repo)
Example:
"/your-org/your-repo"
Numeric ID for this parse job
Example:
5
Position in the queue. null if the job started immediately
Example:
1
Was this page helpful?
⌘I