SWISS-MODEL REST API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library --><scriptsrc="/static/rest_framework/js/coreapi-0.1.1.js"></script><scriptsrc="/coreapi/schema.js"></script>

# Install the Python client library
$ pip install coreapi

alignment

create

POST/alignment/

Start a new modelling project in Alignment mode. The project will remain on our file system for up to 14 days.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`target_sequences`required	Amino acid sequence as a string, or as a list for hetero targets ["sequence","sequence",...]
`template_sequence`required	Template sequence
`template_seqres_offset`required	Offset of the provided template_sequence on the seqres (defined as the mmCIF entity_poly_seq category).
`pdb_id`required	PDB ID of the template
`auth_asym_id`required	PDB author chain name
`assembly_id`	Biounit assembly ID
`project_title`

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action alignment create -p target_sequences=... -p template_sequence=... -p template_seqres_offset=... -p pdb_id=... -p auth_asym_id=... -p assembly_id=... -p project_title=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["alignment","create"]varparams={target_sequences:...,template_sequence:...,template_seqres_offset:...,pdb_id:...,auth_asym_id:...,assembly_id:...,project_title:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["alignment","create"]params={"target_sequences":...,"template_sequence":...,"template_seqres_offset":...,"pdb_id":...,"auth_asym_id":...,"assembly_id":...,"project_title":...,}result=client.action(schema,action,params=params)

api-token-auth

create

POST/api-token-auth/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`required	Valid username for authentication
`password`required	Valid password for authentication

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action api-token-auth create -p username=... -p password=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["api-token-auth","create"]varparams={username:...,password:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["api-token-auth","create"]params={"username":...,"password":...,}result=client.action(schema,action,params=params)

atlas

results > read

GET/atlas/results/{md5}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`md5`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action atlas results read -p md5=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["atlas","results &gt; read"]varparams={md5:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["atlas","results &gt; read"]params={"md5":...,}result=client.action(schema,action,params=params)

search > create

POST/atlas/search/

Start a new search on atlas data.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`query`required	Sequence as string / PDB structure as string

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action atlas search create -p query=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["atlas","search &gt; create"]varparams={query:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["atlas","search &gt; create"]params={"query":...,}result=client.action(schema,action,params=params)

automodel

create

POST/automodel/

Start a new modelling project in AutoModel mode. The project will remain on our file system for up to 14 days.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`target_sequences`required	Amino acid sequence as a string, or as a list for hetero targets ["sequence","sequence",...]
`project_title`

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action automodel create -p target_sequences=... -p project_title=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["automodel","create"]varparams={target_sequences:...,project_title:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["automodel","create"]params={"target_sequences":...,"project_title":...,}result=client.action(schema,action,params=params)

project

models > read

GET/project/{project_id}/models/{model_id}.pdb

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project_id`required
`model_id`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action project models read -p project_id=... -p model_id=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["project","models &gt; read"]varparams={project_id:...,model_id:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["project","models &gt; read"]params={"project_id":...,"model_id":...,}result=client.action(schema,action,params=params)

models > read_0

GET/project/{project_id}/models/{model_id}.pdb.gz

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project_id`required
`model_id`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action project models read_0 -p project_id=... -p model_id=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["project","models &gt; read_0"]varparams={project_id:...,model_id:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["project","models &gt; read_0"]params={"project_id":...,"model_id":...,}result=client.action(schema,action,params=params)

models > full-details > read

GET/project/{project_id}/models/full-details/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project_id`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action project models full-details read -p project_id=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["project","models &gt; full-details &gt; read"]varparams={project_id:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["project","models &gt; full-details &gt; read"]params={"project_id":...,}result=client.action(schema,action,params=params)

models > full-details > read_0

GET/project/{project_id}/models/full-details/{model_id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project_id`required
`model_id`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action project models full-details read_0 -p project_id=... -p model_id=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["project","models &gt; full-details &gt; read_0"]varparams={project_id:...,model_id:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["project","models &gt; full-details &gt; read_0"]params={"project_id":...,"model_id":...,}result=client.action(schema,action,params=params)

models > summary > read

GET/project/{project_id}/models/summary/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project_id`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action project models summary read -p project_id=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["project","models &gt; summary &gt; read"]varparams={project_id:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["project","models &gt; summary &gt; read"]params={"project_id":...,}result=client.action(schema,action,params=params)

projects

read

GET/projects/

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action projects read

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["projects","read"]client.action(schema,action).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["projects","read"]result=client.action(schema,action)

download > create

POST/projects/download/

Create a package containing all coordinates, metadata and an overall summary for COMPLETED projects. The package .zip will remain on our file system for up to 2 days.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`from_datetime`	Download projects created after from_datetime, Must be in isoformat, in a JSON object. eg { "from_datetime": "2022-03-21T10:05:20" }
`to_datetime`	Download projects created before to_datetime, Must be in isoformat, in a JSON object. eg { "to_datetime": "2022-03-22T12:12:20" }

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action projects download create -p from_datetime=... -p to_datetime=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["projects","download &gt; create"]varparams={from_datetime:...,to_datetime:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["projects","download &gt; create"]params={"from_datetime":...,"to_datetime":...,}result=client.action(schema,action,params=params)

download > read

GET/projects/download/{download_id}/

Obtain a download URL for the packaged data file (if status for download_id is COMPLETED). The package .zip will remain on our file system for up to 2 days.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`download_id`required

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action projects download read -p download_id=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["projects","download &gt; read"]varparams={download_id:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["projects","download &gt; read"]params={"download_id":...,}result=client.action(schema,action,params=params)

user_template

create

POST/user_template/

Start a new modelling project in User Template mode. The project will remain on our file system for up to 14 days.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`template_coordinates`required
`target_sequences`required	Amino acid sequence as a string, or as a list for hetero targets ["sequence","sequence",...]
`project_title`

# Load the schema document
$ coreapi get https://swissmodel.expasy.org/coreapi/

# Interact with the API endpoint
$ coreapi action user_template create -p template_coordinates=... -p target_sequences=... -p project_title=...

varcoreapi=window.coreapi// Loaded by `coreapi.js`varschema=window.schema// Loaded by `schema.js`// Initialize a clientvarclient=newcoreapi.Client()// Interact with the API endpointvaraction=["user_template","create"]varparams={template_coordinates:...,target_sequences:...,project_title:...,}client.action(schema,action,params).then(function(result){// Return value is in 'result'})

importcoreapi# Initialize a client & load the schema documentclient=coreapi.Client()schema=client.get("https://swissmodel.expasy.org/coreapi/")# Interact with the API endpointaction=["user_template","create"]params={"template_coordinates":...,"target_sequences":...,"project_title":...,}result=client.action(schema,action,params=params)