Scribd
Upload
10 views5 pages

WellogIQ API Project Management Guide

The WellogIQ API 2.0 OAS 3.1 provides endpoints for managing projects, wells, and jobs, including creating, updating, and deleting resources. It includes a POST request to create a project with a specified name, description, and associated wells and curves, along with responses for success and error handling. Additional functionalities include streaming events, checking run statuses, and managing job artifacts.

Uploaded by

jjunk2022
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
10 views5 pages

WellogIQ API Project Management Guide

The WellogIQ API 2.0 OAS 3.1 provides endpoints for managing projects, wells, and jobs, including creating, updating, and deleting resources. It includes a POST request to create a project with a specified name, description, and associated wells and curves, along with responses for success and error handling. Additional functionalities include streaming events, checking run statuses, and managing job artifacts.

Uploaded by

jjunk2022
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

WellogIQ API

2.0 OAS 3.1

/[Link]

projects
GET /projects/ List Projects

POST /projects/ Create Project

Create a new project.

Parameters Cancel Reset

No parameters

required
Request body application/json

Edit Value Schema

{
"name": "Demo Field X",
"description": "Auto test tree",
"wells": [
{
"name": "Well-A",
"curves": [
{ "name": "GR", "unit": "API" },
{ "name": "RHOB", "unit": "g/cc" }
]
},
{
"name": "Well-B",
"curves": [
{ "name": "NPHI", "unit": "v/v" }
]
}
]
}
Execute Clear

Responses

Curl

curl -X 'POST' \
'[Link] \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"name": "Demo Field X",
"description": "Auto test tree",
"wells": [
{
"name": "Well-A",
"curves": [
{ "name": "GR", "unit": "API" },
{ "name": "RHOB", "unit": "g/cc" }
]
},
{
"name": "Well-B",
"curves": [
{ "name": "NPHI", "unit": "v/v" }
]
}
]
}
'

Request URL

[Link]

Server response

Code Details

500 Error: Internal Server Error


Undocumented
Response body

Internal Server Error

Download

Response headers

content-length: 21
content-type: text/plain; charset=utf-8
date: Thu,16 Oct 2025 10:46:38 GMT
server: uvicorn

Responses
Code Description Links

200 Successful Response No links

Media type

application/json
Controls Accept header.

Example Value Schema

{
"name": "string",
"description": "string",
"id": "string",
"created_at": "2025-10-16T10:46:39.625Z",
"wells": [
{
"name": "string",
"project_id": "string",
"id": "string",
"created_at": "2025-10-16T10:46:39.626Z",
"curves": [
{
"id": 0,
"name": "string",
"unit": "string",
"well_id": "string"
}
]
}
]
}

422 Validation Error No links

Media type

application/json

Example Value Schema

{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}

PATCH /projects/{pid} Update Project

DELETE /projects/{pid} Delete Project


GET /projects/{pid}/wells List Wells

POST /projects/{pid}/wells Create Well

PATCH /projects/wells/{wid} Update Well

DELETE /projects/wells/{wid} Delete Well

runs
GET /runs/{run_id}/events Stream Events

GET /runs/{run_id}/status Get Status

POST /runs/{run_id}/abort Abort Run

POST /runs/{run_id}/pause Pause Run

POST /runs/{run_id}/resume Resume Run

POST /runs/{run_id}/paycurve Run Pay Curve Detection

default
POST /projects/{project}/jobs/pipeline Run Pipeline Job

POST /projects/{project}/jobs Create Job

GET /jobs/{job_id} Get Job

GET /jobs/{job_id}/artifacts Get Job Artifacts

curves
GET /curves/{well_id} Get Curves
system
GET /health Health

Schemas

ArtifactItem Expand all object

Body_create_job_projects__project__jobs_post Expand all object

Curve Expand all object

HTTPValidationError Expand all object

JobCreateResponse Expand all object

JobStatus Expand all object

PipelineJobIn Expand all object

Project Expand all object

ProjectCreate Expand all object

ValidationError Expand all object

Well Expand all object

WellCreate Expand all object

You might also like