Skip to main content
POST
/
models
Create model
curl --request POST \
  --url https://api.prequel.co/models \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "model": {
    "model_name": "<string>",
    "columns": [
      {
        "name_in_source": "<string>",
        "name_in_destination": "<string>",
        "data_type": "<string>",
        "is_primary_key": true,
        "is_last_modified": true
      }
    ],
    "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "source_table": "<string>",
    "source_query": "<string>",
    "destination_table_name": "<string>",
    "organization_column": "<string>",
    "skip_transfer_source_validation": false,
    "is_append_only": true,
    "model_validation_id_in_provider_system": "<string>",
    "model_validation_start_time_epoch": "2023-11-07T05:31:56Z",
    "model_validation_end_time_epoch": "2023-11-07T05:31:56Z",
    "model_validation_tags": {}
  },
  "skip_model_validation": true
}
'
import requests

url = "https://api.prequel.co/models"

payload = {
    "model": {
        "model_name": "<string>",
        "columns": [
            {
                "name_in_source": "<string>",
                "name_in_destination": "<string>",
                "data_type": "<string>",
                "is_primary_key": True,
                "is_last_modified": True
            }
        ],
        "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "source_table": "<string>",
        "source_query": "<string>",
        "destination_table_name": "<string>",
        "organization_column": "<string>",
        "skip_transfer_source_validation": False,
        "is_append_only": True,
        "model_validation_id_in_provider_system": "<string>",
        "model_validation_start_time_epoch": "2023-11-07T05:31:56Z",
        "model_validation_end_time_epoch": "2023-11-07T05:31:56Z",
        "model_validation_tags": {}
    },
    "skip_model_validation": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: {
      model_name: '<string>',
      columns: [
        {
          name_in_source: '<string>',
          name_in_destination: '<string>',
          data_type: '<string>',
          is_primary_key: true,
          is_last_modified: true
        }
      ],
      source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      description: '<string>',
      source_table: '<string>',
      source_query: '<string>',
      destination_table_name: '<string>',
      organization_column: '<string>',
      skip_transfer_source_validation: false,
      is_append_only: true,
      model_validation_id_in_provider_system: '<string>',
      model_validation_start_time_epoch: '2023-11-07T05:31:56Z',
      model_validation_end_time_epoch: '2023-11-07T05:31:56Z',
      model_validation_tags: {}
    },
    skip_model_validation: true
  })
};

fetch('https://api.prequel.co/models', 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://api.prequel.co/models",
  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([
    'model' => [
        'model_name' => '<string>',
        'columns' => [
                [
                                'name_in_source' => '<string>',
                                'name_in_destination' => '<string>',
                                'data_type' => '<string>',
                                'is_primary_key' => true,
                                'is_last_modified' => true
                ]
        ],
        'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'description' => '<string>',
        'source_table' => '<string>',
        'source_query' => '<string>',
        'destination_table_name' => '<string>',
        'organization_column' => '<string>',
        'skip_transfer_source_validation' => false,
        'is_append_only' => true,
        'model_validation_id_in_provider_system' => '<string>',
        'model_validation_start_time_epoch' => '2023-11-07T05:31:56Z',
        'model_validation_end_time_epoch' => '2023-11-07T05:31:56Z',
        'model_validation_tags' => [
                
        ]
    ],
    'skip_model_validation' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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://api.prequel.co/models"

	payload := strings.NewReader("{\n  \"model\": {\n    \"model_name\": \"<string>\",\n    \"columns\": [\n      {\n        \"name_in_source\": \"<string>\",\n        \"name_in_destination\": \"<string>\",\n        \"data_type\": \"<string>\",\n        \"is_primary_key\": true,\n        \"is_last_modified\": true\n      }\n    ],\n    \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"description\": \"<string>\",\n    \"source_table\": \"<string>\",\n    \"source_query\": \"<string>\",\n    \"destination_table_name\": \"<string>\",\n    \"organization_column\": \"<string>\",\n    \"skip_transfer_source_validation\": false,\n    \"is_append_only\": true,\n    \"model_validation_id_in_provider_system\": \"<string>\",\n    \"model_validation_start_time_epoch\": \"2023-11-07T05:31:56Z\",\n    \"model_validation_end_time_epoch\": \"2023-11-07T05:31:56Z\",\n    \"model_validation_tags\": {}\n  },\n  \"skip_model_validation\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	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://api.prequel.co/models")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": {\n    \"model_name\": \"<string>\",\n    \"columns\": [\n      {\n        \"name_in_source\": \"<string>\",\n        \"name_in_destination\": \"<string>\",\n        \"data_type\": \"<string>\",\n        \"is_primary_key\": true,\n        \"is_last_modified\": true\n      }\n    ],\n    \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"description\": \"<string>\",\n    \"source_table\": \"<string>\",\n    \"source_query\": \"<string>\",\n    \"destination_table_name\": \"<string>\",\n    \"organization_column\": \"<string>\",\n    \"skip_transfer_source_validation\": false,\n    \"is_append_only\": true,\n    \"model_validation_id_in_provider_system\": \"<string>\",\n    \"model_validation_start_time_epoch\": \"2023-11-07T05:31:56Z\",\n    \"model_validation_end_time_epoch\": \"2023-11-07T05:31:56Z\",\n    \"model_validation_tags\": {}\n  },\n  \"skip_model_validation\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.prequel.co/models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": {\n    \"model_name\": \"<string>\",\n    \"columns\": [\n      {\n        \"name_in_source\": \"<string>\",\n        \"name_in_destination\": \"<string>\",\n        \"data_type\": \"<string>\",\n        \"is_primary_key\": true,\n        \"is_last_modified\": true\n      }\n    ],\n    \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"description\": \"<string>\",\n    \"source_table\": \"<string>\",\n    \"source_query\": \"<string>\",\n    \"destination_table_name\": \"<string>\",\n    \"organization_column\": \"<string>\",\n    \"skip_transfer_source_validation\": false,\n    \"is_append_only\": true,\n    \"model_validation_id_in_provider_system\": \"<string>\",\n    \"model_validation_start_time_epoch\": \"2023-11-07T05:31:56Z\",\n    \"model_validation_end_time_epoch\": \"2023-11-07T05:31:56Z\",\n    \"model_validation_tags\": {}\n  },\n  \"skip_model_validation\": true\n}"

response = http.request(request)
puts response.read_body
{
  "status": "<string>",
  "data": {
    "model": {
      "model_name": "<string>",
      "columns": [
        {
          "name_in_source": "<string>",
          "name_in_destination": "<string>",
          "data_type": "<string>",
          "is_primary_key": true,
          "is_last_modified": true
        }
      ],
      "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "source_table": "<string>",
      "source_query": "<string>",
      "destination_table_name": "<string>",
      "organization_column": "<string>",
      "skip_transfer_source_validation": false,
      "is_append_only": true,
      "model_validation_id_in_provider_system": "<string>",
      "model_validation_start_time_epoch": "2023-11-07T05:31:56Z",
      "model_validation_end_time_epoch": "2023-11-07T05:31:56Z",
      "model_validation_tags": {}
    }
  },
  "message": "<string>"
}
{
  "status": "<string>",
  "message": "<string>",
  "data": null
}
{
  "status": "<string>",
  "message": "<string>",
  "data": null
}
{
  "status": "<string>",
  "message": "<string>",
  "data": null
}
{
  "status": "<string>",
  "message": "<string>",
  "data": null
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
model
object
required
​
skip_model_validation
boolean

Whether to skip the validation of this model against the specified source.

Response

OK

​
status
string
required
Allowed value: "success"
​
data
object
required
​
message
string
required