{
  "opencollection": "1.0.0",
  "info": {
    "name": "Structify account dataset API",
    "version": "0.1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api_key",
      "value": "{{api_key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "dataset",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a property descriptor to a table in the dataset schema",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/add_property",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Add a property descriptor to a table in the dataset schema"
        },
        {
          "info": {
            "name": "dataset_count_missing_embeddings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/count_missing_embeddings",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "Create a Dataset",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/create",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Creates a dataset."
        },
        {
          "info": {
            "name": "Permanently delete a dataset and all its contents",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.structify.ai/dataset/delete",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the dataset"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Permanently delete a dataset and all its contents"
        },
        {
          "info": {
            "name": "Get the enrichment progress for a dataset",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/enrichment_progress",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Enrichment progress for the dataset"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Get the enrichment progress for a dataset"
        },
        {
          "info": {
            "name": "dataset_entity_ws",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/entity_ws",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the dataset to monitor"
              },
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "API key for authentication"
              },
              {
                "name": "session_token",
                "value": "",
                "type": "query",
                "description": "Session token for authentication"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "Delete a dataset evaluation result by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.structify.ai/dataset/evaluate/delete",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a dataset evaluation result by ID"
        },
        {
          "info": {
            "name": "Get a dataset evaluation result by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/evaluate/get",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Get a dataset evaluation result by ID"
        },
        {
          "info": {
            "name": "List all dataset evaluation results with pagination",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/evaluate/list",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "List all dataset evaluation results with pagination"
        },
        {
          "info": {
            "name": "Evaluate two datasets",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/evaluate/run",
            "params": [
              {
                "name": "dataset_1",
                "value": "",
                "type": "query"
              },
              {
                "name": "dataset_2",
                "value": "",
                "type": "query"
              },
              {
                "name": "dataset_2_is_ground_truth",
                "value": "",
                "type": "query"
              },
              {
                "name": "merge_threshold_override",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Evaluate two datasets"
        },
        {
          "info": {
            "name": "Get the status of a dataset evaluation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/evaluate/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Get the status of a dataset evaluation"
        },
        {
          "info": {
            "name": "Export entities from a table in your dataset as CSV.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/export_to_csv",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "You need to specify a dataset and a table_name"
        },
        {
          "info": {
            "name": "Export all tables and relationships from your dataset as an Excel file.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/export_to_excel",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Each table and relationship type will be in its own sheet"
        },
        {
          "info": {
            "name": "Grab a dataset by its name.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/info",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Information about the dataset"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Grab a dataset by its name."
        },
        {
          "info": {
            "name": "WebSocket endpoint for job updates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/job_ws",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the dataset to monitor"
              },
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "API key for authentication"
              },
              {
                "name": "session_token",
                "value": "",
                "type": "query",
                "description": "Session token for authentication"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "WebSocket endpoint for job updates"
        },
        {
          "info": {
            "name": "List datasets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/list",
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Gets all datasets owned by the current user"
        },
        {
          "info": {
            "name": "Given a query subgraph, find the most similar subgraph in the existing dataset.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/match",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns: The matched subgraph and a score for the match."
        },
        {
          "info": {
            "name": "Remove a property descriptor from a table in the dataset schema",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/remove_property",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Remove a property descriptor from a table in the dataset schema"
        },
        {
          "info": {
            "name": "dataset_reorder_properties",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/reorder_properties",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "dataset_set_primary_column",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/set_primary_column",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "Update a property descriptor in a table in the dataset schema",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/update_property",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Update a property descriptor in a table in the dataset schema"
        },
        {
          "info": {
            "name": "Update a relationship descriptor in the dataset schema",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.structify.ai/dataset/update_relationship",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Update a relationship descriptor in the dataset schema"
        },
        {
          "info": {
            "name": "View relationships in your dataset.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/view_relationships",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_updated",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "You need to specify a dataset and the name of the relationship"
        },
        {
          "info": {
            "name": "View entities from a table in your dataset.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/view_table",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_updated",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "You need to specify a dataset and a table_name"
        },
        {
          "info": {
            "name": "Paginates through the entities. As its paginating through the entities, it gets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.structify.ai/dataset/view_tables_with_relationships",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_updated",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "the relationships for each entity and the targets for each relationship."
        }
      ]
    }
  ],
  "bundled": true
}