Create Model | Polytomic Docs

import requests
url = "https://app.polytomic.com/api/models"
payload = {
    "configuration": { "table": "public.users" },
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "name": "Users"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "data": {
    "configuration": {
      "table": "public.contacts"
    },
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "enricher": {
      "configuration": {
        "key": "value"
      },
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "fields": [
        {
          "description": "Unique identifier",
          "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
          "label": "ID",
          "name": "phone_number",
          "remote_type": "string",
          "type": "string",
          "unique": true,
          "user_added": false
        }
      ],
      "mappings": {
        "key": "value"
      }
    },
    "fields": [
      {
        "description": "Unique identifier",
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "label": "ID",
        "name": "id",
        "remote_type": "string",
        "type": "string",
        "unique": true,
        "user_added": false
      }
    ],
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "identifier": "id",
    "labels": [
      {
        "key": "value"
      }
    ],
    "name": "Contacts",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "relations": [
      {
        "from": "id"
      }
    ],
    "tracking_columns": [
      "tracking_columns"
    ],
    "type": "postgresql",
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "version": 1
  },
  "job": {
    "error": "error message",
    "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "result": {
      "key": "value"
    },
    "status": "created",
    "type": "createmodel"
  }
}

Authentication

AuthorizationBearer

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

Query parameters

asyncbooleanOptional

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

connection_idstringRequiredformat: "uuid"

namestringRequired

additional_fieldslist of objectsOptional

enricherobjectOptional

fieldslist of stringsOptional

identifierstringOptional

labelslist of stringsOptional

organization_idstringOptionalformat: "uuid"

policieslist of stringsOptional

relationslist of objectsOptional

tracking_columnslist of stringsOptional

Response

dataobject

jobobject

Errors

400

Models Create Request Bad Request Error

401

Models Create Request Unauthorized Error

403

Models Create Request Forbidden Error

500

Models Create Request Internal Server Error

Authentication

Headers

Query parameters

Request

Response

Errors