curl --request POST \
--url https://sdk.nimbleway.com/v2/extract/templates/generations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"url": "<string>",
"input_schema": {},
"metadata": {
"description": "<string>",
"display_name": "<string>",
"tags": [
"<string>"
]
},
"name": "<string>",
"output_schema": {}
}
'import requests
url = "https://sdk.nimbleway.com/v2/extract/templates/generations"
payload = {
"prompt": "<string>",
"url": "<string>",
"input_schema": {},
"metadata": {
"description": "<string>",
"display_name": "<string>",
"tags": ["<string>"]
},
"name": "<string>",
"output_schema": {}
}
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({
prompt: '<string>',
url: '<string>',
input_schema: {},
metadata: {description: '<string>', display_name: '<string>', tags: ['<string>']},
name: '<string>',
output_schema: {}
})
};
fetch('https://sdk.nimbleway.com/v2/extract/templates/generations', 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://sdk.nimbleway.com/v2/extract/templates/generations",
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([
'prompt' => '<string>',
'url' => '<string>',
'input_schema' => [
],
'metadata' => [
'description' => '<string>',
'display_name' => '<string>',
'tags' => [
'<string>'
]
],
'name' => '<string>',
'output_schema' => [
]
]),
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://sdk.nimbleway.com/v2/extract/templates/generations"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"url\": \"<string>\",\n \"input_schema\": {},\n \"metadata\": {\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"name\": \"<string>\",\n \"output_schema\": {}\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://sdk.nimbleway.com/v2/extract/templates/generations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"url\": \"<string>\",\n \"input_schema\": {},\n \"metadata\": {\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"name\": \"<string>\",\n \"output_schema\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v2/extract/templates/generations")
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 \"prompt\": \"<string>\",\n \"url\": \"<string>\",\n \"input_schema\": {},\n \"metadata\": {\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"name\": \"<string>\",\n \"output_schema\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"generated_version": {
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input_schema": {},
"metadata": {
"data_source": "<string>",
"description": "<string>",
"display_name": "<string>",
"domain": "<string>",
"entity_type": "<string>",
"tags": [
"<string>"
],
"vertical": "<string>"
},
"name": "<string>",
"output_schema": {},
"version_number": 123,
"samples": [
{
"input": "<unknown>",
"output": "<unknown>"
}
]
},
"generated_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"summary": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Create Extract Template Generation
curl --request POST \
--url https://sdk.nimbleway.com/v2/extract/templates/generations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"url": "<string>",
"input_schema": {},
"metadata": {
"description": "<string>",
"display_name": "<string>",
"tags": [
"<string>"
]
},
"name": "<string>",
"output_schema": {}
}
'import requests
url = "https://sdk.nimbleway.com/v2/extract/templates/generations"
payload = {
"prompt": "<string>",
"url": "<string>",
"input_schema": {},
"metadata": {
"description": "<string>",
"display_name": "<string>",
"tags": ["<string>"]
},
"name": "<string>",
"output_schema": {}
}
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({
prompt: '<string>',
url: '<string>',
input_schema: {},
metadata: {description: '<string>', display_name: '<string>', tags: ['<string>']},
name: '<string>',
output_schema: {}
})
};
fetch('https://sdk.nimbleway.com/v2/extract/templates/generations', 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://sdk.nimbleway.com/v2/extract/templates/generations",
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([
'prompt' => '<string>',
'url' => '<string>',
'input_schema' => [
],
'metadata' => [
'description' => '<string>',
'display_name' => '<string>',
'tags' => [
'<string>'
]
],
'name' => '<string>',
'output_schema' => [
]
]),
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://sdk.nimbleway.com/v2/extract/templates/generations"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"url\": \"<string>\",\n \"input_schema\": {},\n \"metadata\": {\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"name\": \"<string>\",\n \"output_schema\": {}\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://sdk.nimbleway.com/v2/extract/templates/generations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"url\": \"<string>\",\n \"input_schema\": {},\n \"metadata\": {\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"name\": \"<string>\",\n \"output_schema\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v2/extract/templates/generations")
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 \"prompt\": \"<string>\",\n \"url\": \"<string>\",\n \"input_schema\": {},\n \"metadata\": {\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"name\": \"<string>\",\n \"output_schema\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"generated_version": {
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input_schema": {},
"metadata": {
"data_source": "<string>",
"description": "<string>",
"display_name": "<string>",
"domain": "<string>",
"entity_type": "<string>",
"tags": [
"<string>"
],
"vertical": "<string>"
},
"name": "<string>",
"output_schema": {},
"version_number": 123,
"samples": [
{
"input": "<unknown>",
"output": "<unknown>"
}
]
},
"generated_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"summary": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- CreateExtractTemplateGenerationRequestPublicV2
- CreateExtractTemplateRefinementRequestPublicV2
Instructions for generating the extract template.
Example URL used to generate the extract template.
Optional JSON schema describing expected input parameters.
Metadata to attach to the generated extract template.
Show child attributes
Show child attributes
Optional stable name for the generated extract template.
1 - 255^[a-z0-9_]+$Optional JSON schema describing desired extracted output.
Response
Successful Response
Unique extract template generation identifier.
Current generation status.
When the generation completed.
When the generation was created.
Error message when generation failed.
Generated version details, when available.
Show child attributes
Show child attributes
Identifier of the generated version.
Extract template name associated with the generation.
Identifier of the version being refined.
When the generation started executing.
Summary of the generation result.
Was this page helpful?