How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gencove Project API

The project API from Gencove — 34 operation(s) for project.

Gencove Project API is one of 20 APIs that Gencove publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 45 operations across 34 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://api.gencove.com.

45 operations 34 paths 61 schemas 4 DELETE20 GET1 PATCH20 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://api.gencove.com/api/v2/
Authentication
API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 2

Gencove Project API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_key). An API key is passed in the header as Authorization (JWT).

  • API_key — Authorization header content formated as: Api-Key You can obtain new API key through Gencove's web UI or user-api-key endpoint
  • JWT — Authorization header content formated as: Bearer You can obtain access token using jwt-create endpoint.

Paths & Operations 45

Across 34 paths, the API surfaces 45 operations — 4 DELETE, 20 GET, 1 PATCH, 20 POST. Each is listed below with its method, path, parameters, and response codes.

Project 45
GET
/api/v2/project-batch-types/{project_id}
Project batch types list
project_batch_types_list 3 params → 200
GET
/api/v2/project-batches/{project_id}
Project batches list
project_batches_list 3 params → 200
POST
/api/v2/project-batches/{project_id}
Project batches create
project_batches_create 1 param body → 201
POST
/api/v2/project-cancel-samples/{project_id}
Project cancel samples create
project_cancel_samples_create 1 param body → 201
DELETE
/api/v2/project-delete-samples/{project_id}
Project delete samples destroy
project_delete_samples_destroy 1 param → 204
POST
/api/v2/project-hide-samples/{project_id}
Project hide samples create
project_hide_samples_create 1 param body → 204
GET
/api/v2/project-merge-vcfs/{project_id}
Project merge vcfs retrieve
project_merge_vcfs_retrieve 1 param → 200
POST
/api/v2/project-merge-vcfs/{project_id}
Project merge vcfs create
project_merge_vcfs_create 1 param → 201
GET
/api/v2/project-organization-users/{project_id}
Project organization users list
project_organization_users_list 4 params → 200
GET
/api/v2/project-qc-report/{project_id}
Project qc report retrieve
project_qc_report_retrieve 2 params → 200
GET
/api/v2/project-qc-types/{project_id}
Project qc types list
project_qc_types_list 3 params → 200
GET
/api/v2/project-quality-control-histogram/{project_id}
Project quality control histogram retrieve
project_quality_control_histogram_retrieve 11 params → 200
POST
/api/v2/project-restore-samples/{project_id}
Project restore samples create
project_restore_samples_create 1 param body → 202
GET
/api/v2/project-roles/{role_id}
Project roles retrieve
project_roles_retrieve 1 param → 200
DELETE
/api/v2/project-roles/{role_id}
Project roles destroy
project_roles_destroy 1 param → 204
GET
/api/v2/project-sample-manifests/{project_id}
Project sample manifests retrieve
project_sample_manifests_retrieve 1 param → 200
POST
/api/v2/project-sample-manifests/{project_id}
Project sample manifests create
project_sample_manifests_create 2 params body → 201
POST
/api/v2/project-samples-copy/
Project samples copy create
project_samples_copy_create body → 202
POST
/api/v2/project-samples-import/
Project samples import create
project_samples_import_create body → 202
GET
/api/v2/project-samples/{project_id}
Project samples list
project_samples_list 13 params → 200
POST
/api/v2/project-samples/{project_id}
Project samples create
project_samples_create 1 param body → 201
POST
/api/v2/project-share-exit/
Project share exit create
project_share_exit_create body → 200
POST
/api/v2/project-share-revoke/{project_share_id}
Project share revoke create
project_share_revoke_create 1 param body → 201
GET
/api/v2/project-shares/
Project shares list
project_shares_list 2 params → 200
POST
/api/v2/project-shares/
Project shares create
project_shares_create body → 201
GET
/api/v2/project-shares/{project_share_id}
Project shares retrieve
project_shares_retrieve 1 param → 200
GET
/api/v2/project-stats/{project_id}
Project stats retrieve
project_stats_retrieve 9 params → 200
GET
/api/v2/project-subscription-details/{subscription_id}
Project subscription details retrieve
project_subscription_details_retrieve 1 param → 200
DELETE
/api/v2/project-subscription-details/{subscription_id}
Project subscription details destroy
project_subscription_details_destroy 1 param → 204
GET
/api/v2/project-subscription-event-types/
Project subscription event types list
project_subscription_event_types_list 2 params → 200
GET
/api/v2/project-subscription-notifications/{subscription_id}
Project subscription notifications list
project_subscription_notifications_list 3 params → 200
POST
/api/v2/project-subscription-secret/{subscription_id}
Project subscription secret create
project_subscription_secret_create 1 param → 200
POST
/api/v2/project-subscription-test/{subscription_id}
Project subscription test create
project_subscription_test_create 1 param body → 202
GET
/api/v2/project-subscriptions/{project_id}
Project subscriptions list
project_subscriptions_list 3 params → 200
POST
/api/v2/project-subscriptions/{project_id}
Project subscriptions create
project_subscriptions_create 1 param body → 201
POST
/api/v2/project-unhide-samples/{project_id}
Project unhide samples create
project_unhide_samples_create 1 param body → 204
GET
/api/v2/project-users/{project_id}
Project users list
project_users_list 5 params → 200
POST
/api/v2/project-users/{project_id}
Project users create
project_users_create 1 param body → 201
GET
/api/v2/projects/
Projects list
projects_list 10 params → 200
POST
/api/v2/projects/
Projects create
projects_create body → 201
DELETE
/api/v2/projects-delete/
Projects delete destroy
projects_delete_destroy → 204
POST
/api/v2/projects-hide/
Projects hide create
projects_hide_create body → 204
POST
/api/v2/projects-unhide/
Projects unhide create
projects_unhide_create body → 204
GET
/api/v2/projects/{project_id}
Projects retrieve
projects_retrieve 1 param → 200
PATCH
/api/v2/projects/{project_id}
Projects partial update
projects_partial_update 1 param body → 200

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are ProjectDetail (17 properties), Project (16 properties), PatchedProject (16 properties), SampleList (11 properties). Each schema is shown below with its type and property counts.

PaginatedQualityControlTypeList
object
2 properties 1 required
ProjectSubscription
object
Subscription serializer where the scope is a project.
7 properties 6 required
PaginatedProjectSubscriptionNotificationList
object
2 properties 1 required
SampleList
object
11 properties 8 required
ProjectFileNested
object
Used for all nested files except for files associated with sample.
7 properties 3 required
OrganizationUser
object
7 properties 5 required
ExtendedSampleSheetCreate
object
Adds samples with their uploads to the project and attaches same metadata to all of them.
2 properties 1 required
SubscriptionSecret
object
Serialize secret of a subscription. Used only for returning the secret, not reading it because the secret is safely encypted in the db.
1 property 1 required
ProjectCancelSamples
object
Serializer for canceling samples submitted to a project.
1 property 1 required
ProtocolEnum
string
webhook - webhook email - email
SampleManifestUpload
object
1 property 1 required
ProjectHideUnhide
object
Serializer for hiding or unhiding a list of projects
1 property 1 required
BatchCreate
object
3 properties 3 required
ProjectUsers
object
6 properties 4 required
QualityControlType
object
6 properties 6 required
ProjectSamplesImport
object
3 properties 2 required
PaginatedEventTypeList
object
2 properties 1 required
EventType
object
Serializing event types using EventType choices options.
2 properties 2 required
BatchDetail
object
6 properties 5 required
EventTypesEnum
string
analysiscompletev2 - submitted project samples have completed analysis batchfinalreportcompletev2 - created subset of variants batch samplesrestored - samples…
FastqsNestedCreate
object
Serialized multiple uploads.models.Uploads objects with r1 and r2 names hardcoded.
2 properties 1 required
PaginatedProjectList
object
2 properties 1 required
ShareLevelEnum
string
viewer - viewer analyst - analyst
SampleStatusNested
object
4 properties 2 required
ProjectShareExit
object
Serializer for exiting multiple project shares
1 property 1 required
PaginatedProjectSubscriptionList
object
2 properties 1 required
PaginatedBatchTypeList
object
2 properties 1 required
UploadNestedCreate
object
Used for adding samples using sample sheet to a project.
1 property 1 required
SampleHideUnhide
object
Serializer for hiding or unhidden a list of samples
1 property 1 required
PaginatedBatchListList
object
2 properties 1 required
PaginatedOrganizationUserList
object
2 properties 1 required
PaginatedProjectShareList
object
2 properties 1 required
JobStatusNested
object
4 properties 2 required
SampleRestore
object
Serializer for restoring samples from archived state. Initially samples are set as restorerequested and a celery task is kicked off that starts restore process…
3 properties 3 required
ExistingSample
object
2 properties 1 required
ProjectDetail
object
Only used when retrieving a single Project.
17 properties 12 required
BatchList
object
5 properties 4 required
ProjectShareStatusStatusEnum
string
shared - shared exited - exited revoked - revoked
EventTypeEnum
string
analysiscompletev2 - submitted project samples have completed analysis batchfinalreportcompletev2 - created subset of variants batch samplesrestored - samples…
ProjectShareStatus
object
4 properties 1 required
BatchFileNested
object
Sets batch.id as filename in file downloadurl.
7 properties 3 required
SubscriptionCreate
object
Generic Subscription serializer without scope object.
4 properties 3 required
PaginatedSampleListList
object
2 properties 1 required
ProjectShareRevoke
object
1 property 1 required
ProjectMergeVCFsJob
object
5 properties 4 required
SampleCounts
object
6 properties 6 required
BatchType
object
2 properties 1 required
ProjectQualityControlHistogram
object
2 properties 2 required
ArchiveSampleStatus
object
4 properties 3 required
ProjectShare
object
9 properties 9 required
ProjectSubscriptionNotification
object
4 properties 2 required
Project
object
16 properties 14 required
NullEnum
PatchedProject
object
16 properties
ProjectStats
object
4 properties 4 required
BatchStatusNested
object
3 properties 2 required
SubscriptionTest
object
Used to accept requests to test subscriptions.
2 properties
PaginatedProjectUsersList
object
2 properties 1 required
SampleSheetCreate
object
Adds samples with their uploads to the project. Samples are being created in create method of this serializer. They don't exist as objects in db before that.
3 properties 3 required
UserRoleObjectCreate
object
2 properties 2 required
UserRoleObject
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gencove-project-api-openapi.yml Raw ↑

Other APIs Gencove publishes across the network.

Gencove Array API
Gencove Basespace API
Gencove Batch API
Gencove Billing API
Gencove Explorer API
Gencove File API
Gencove Firstmile API
Gencove Invitation API
Gencove JWT API
Gencove Mfa API
Gencove Notification API
Gencove Organization API
Where this information came from

This is an independent, third-party profile of Gencove Project API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.